contrib/libpcap/pcap_open_offline.3pcap.in

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_open_offline.3pcap.in,v 1.1 2008-10-23 05:56:59 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_OPEN_OFFLINE 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_open_offline, pcap_fopen_offline \- open a saved capture file for reading
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .LP
  31 .nf
  32 .ft B
  33 char errbuf[PCAP_ERRBUF_SIZE];
  34 .ft
  35 .LP
  36 .ft B
  37 pcap_t *pcap_open_offline(const char *fname, char *errbuf);
  38 pcap_t *pcap_fopen_offline(FILE *fp, char *errbuf);
  39 .ft
  40 .fi
  41 .SH DESCRIPTION
  42 .B pcap_open_offline()
  43 is called to open a ``savefile'' for reading.
  44 .PP
  45 .I fname
  46 specifies the name of the file to open. The file can have the pcap file
  47 format as described in
  48 .BR pcap-savefile (@MAN_FILE_FORMATS@),
  49 which is the file format used by, among other programs,
  50 .BR tcpdump (1)
  51 and
  52 .BR tcpslice (1),
  53 or can have the pcap-ng file format, although not all pcap-ng files can
  54 be read.
  55 The name "-" in a synonym for
  56 .BR stdin .
  57 .PP
  58 Alternatively, you may call
  59 .B pcap_fopen_offline()
  60 to read dumped data from an existing open stream
  61 .IR fp .
  62 Note that on Windows, that stream should be opened in binary mode.
  63 .SH RETURN VALUE
  64 .B pcap_open_offline()
  65 and
  66 .B pcap_fopen_offline()
  67 return a
  68 .I pcap_t *
  69 on success and
  70 .B NULL
  71 on failure.
  72 If
  73 .B NULL
  74 is returned,
  75 .I errbuf
  76 is filled in with an appropriate error message.
  77 .I errbuf
  78 is assumed to be able to hold at least
  79 .B PCAP_ERRBUF_SIZE
  80 chars.
  81 .SH SEE ALSO
  82 pcap(3PCAP), pcap-savefile(@MAN_FILE_FORMATS@)