external/bsd/libpcap/dist/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_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 (8)
  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 Note that on Windows, that stream should be opened in binary mode.
  53 .PP
  54 .I p
  55 is a capture or ``savefile'' handle returned by an earlier call to
  56 .B pcap_create()
  57 and activated by an earlier call to
  58 .BR pcap_activate() ,
  59 or returned by an earlier call to
  60 .BR pcap_open_offline() ,
  61 .BR pcap_open_live() ,
  62 or
  63 .BR pcap_open_dead() .
  64 The time stamp precision, link-layer type, and snapshot length from
  65 .I p
  66 are used as the link-layer type and snapshot length of the output file.
  67 .PP
  68 .B pcap_dump_open_append()
  69 is like
  70 .B pcap_dump_open
  71 but does not create the file if it does not exist and, if it does
  72 already exist, and is a pcap file with the same byte order as the host
  73 opening the file, and has the same time stamp precision, link-layer
  74 header type, and snapshot length as
  75 .IR p ,
  76 it will write new packets at the end of the file.
  77 .SH RETURN VALUES
  78 A pointer to a
  79 .B pcap_dumper_t
  80 structure to use in subsequent
  81 .B pcap_dump()
  82 and
  83 .B pcap_dump_close()
  84 calls is returned on success.
  85 .B NULL
  86 is returned on failure.
  87 If
  88 .B NULL
  89 is returned,
  90 .B pcap_geterr(\fIp\fB)
  91 can be used to get the error text.
  92 .SH SEE ALSO
  93 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
  94 pcap_open_offline(3PCAP), pcap_open_live(3PCAP), pcap_open_dead(3PCAP),
  95 pcap_dump(3PCAP), pcap_dump_close(3PCAP), pcap_geterr(3PCAP),
  96 pcap-savefile(@MAN_FILE_FORMATS@)