Blame pcap_open_offline.3pcap.in

Packit 209cc3
.\" Copyright (c) 1994, 1996, 1997
Packit 209cc3
.\"	The Regents of the University of California.  All rights reserved.
Packit 209cc3
.\"
Packit 209cc3
.\" Redistribution and use in source and binary forms, with or without
Packit 209cc3
.\" modification, are permitted provided that: (1) source code distributions
Packit 209cc3
.\" retain the above copyright notice and this paragraph in its entirety, (2)
Packit 209cc3
.\" distributions including binary code include the above copyright notice and
Packit 209cc3
.\" this paragraph in its entirety in the documentation or other materials
Packit 209cc3
.\" provided with the distribution, and (3) all advertising materials mentioning
Packit 209cc3
.\" features or use of this software display the following acknowledgement:
Packit 209cc3
.\" ``This product includes software developed by the University of California,
Packit 209cc3
.\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
Packit 209cc3
.\" the University nor the names of its contributors may be used to endorse
Packit 209cc3
.\" or promote products derived from this software without specific prior
Packit 209cc3
.\" written permission.
Packit 209cc3
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
Packit 209cc3
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
Packit 209cc3
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Packit 209cc3
.\"
Packit 209cc3
.TH PCAP_OPEN_OFFLINE 3PCAP "8 January 2018 "
Packit 209cc3
.SH NAME
Packit 209cc3
pcap_open_offline, pcap_open_offline_with_tstamp_precision,
Packit 209cc3
pcap_fopen_offline, pcap_fopen_offline_with_tstamp_precision \- open a saved capture file for reading
Packit 209cc3
.SH SYNOPSIS
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
#include <pcap/pcap.h>
Packit 209cc3
.ft
Packit 209cc3
.LP
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
char errbuf[PCAP_ERRBUF_SIZE];
Packit 209cc3
.ft
Packit 209cc3
.LP
Packit 209cc3
.ft B
Packit 209cc3
pcap_t *pcap_open_offline(const char *fname, char *errbuf);
Packit 209cc3
pcap_t *pcap_open_offline_with_tstamp_precision(const char *fname,
Packit 209cc3
    u_int precision, char *errbuf);
Packit 209cc3
pcap_t *pcap_fopen_offline(FILE *fp, char *errbuf);
Packit 209cc3
pcap_t *pcap_fopen_offline_with_tstamp_precision(FILE *fp,
Packit 209cc3
    u_int precision, char *errbuf);
Packit 209cc3
.ft
Packit 209cc3
.fi
Packit 209cc3
.SH DESCRIPTION
Packit 209cc3
.B pcap_open_offline()
Packit 209cc3
and
Packit 209cc3
.B pcap_open_offline_with_tstamp_precision()
Packit 209cc3
are called to open a ``savefile'' for reading.
Packit 209cc3
.PP
Packit 209cc3
.I fname
Packit 209cc3
specifies the name of the file to open. The file can have the pcap file
Packit 209cc3
format as described in
Packit 209cc3
.BR pcap-savefile (@MAN_FILE_FORMATS@),
Packit 209cc3
which is the file format used by, among other programs,
Packit 209cc3
.BR tcpdump (1)
Packit 209cc3
and
Packit 209cc3
.BR tcpslice (1),
Packit 209cc3
or can have the pcapng file format, although not all pcapng files can
Packit 209cc3
be read.
Packit 209cc3
The name "-" is a synonym for
Packit 209cc3
.BR stdin .
Packit 209cc3
.PP
Packit 209cc3
.B pcap_open_offline_with_tstamp_precision()
Packit 209cc3
takes an additional
Packit 209cc3
.I precision
Packit 209cc3
argument specifying the time stamp precision desired;
Packit 209cc3
if
Packit 209cc3
.B PCAP_TSTAMP_PRECISION_MICRO
Packit 209cc3
is specified, packet time stamps will be supplied in seconds and
Packit 209cc3
microseconds,
Packit 209cc3
and if
Packit 209cc3
.B PCAP_TSTAMP_PRECISION_NANO
Packit 209cc3
is specified, packet time stamps will be supplied in seconds and
Packit 209cc3
nanoseconds.  If the time stamps in the file do not have the same
Packit 209cc3
precision as the requested precision, they will be scaled up or down as
Packit 209cc3
necessary before being supplied.
Packit 209cc3
.PP
Packit 209cc3
Alternatively, you may call
Packit 209cc3
.B pcap_fopen_offline()
Packit 209cc3
or
Packit 209cc3
.B pcap_fopen_offline_with_tstamp_precision()
Packit 209cc3
to read dumped data from an existing open stream
Packit 209cc3
.IR fp .
Packit 209cc3
.B pcap_fopen_offline_with_tstamp_precision()
Packit 209cc3
takes an additional
Packit 209cc3
.I precision
Packit 209cc3
argument as described above.
Packit 209cc3
Note that on Windows, that stream should be opened in binary mode.
Packit 209cc3
.SH RETURN VALUE
Packit 209cc3
.BR pcap_open_offline() ,
Packit 209cc3
.BR pcap_open_offline_with_tstamp_precision() ,
Packit 209cc3
.BR pcap_fopen_offline() ,
Packit 209cc3
and
Packit 209cc3
.B pcap_fopen_offline_with_tstamp_precision()
Packit 209cc3
return a
Packit 209cc3
.I pcap_t *
Packit 209cc3
on success and
Packit 209cc3
.B NULL
Packit 209cc3
on failure.
Packit 209cc3
If
Packit 209cc3
.B NULL
Packit 209cc3
is returned,
Packit 209cc3
.I errbuf
Packit 209cc3
is filled in with an appropriate error message.
Packit 209cc3
.I errbuf
Packit 209cc3
is assumed to be able to hold at least
Packit 209cc3
.B PCAP_ERRBUF_SIZE
Packit 209cc3
chars.
Packit 209cc3
.SH BACKWARD COMPATIBILITY
Packit 209cc3
.B pcap_open_offline_with_tstamp_precision
Packit 209cc3
and
Packit 209cc3
.B pcap_fopen_offline_with_tstamp_precision
Packit 209cc3
became available in libpcap release 1.5.1.  In previous releases, time
Packit 209cc3
stamps from a savefile are always given in seconds and microseconds.
Packit 209cc3
.SH SEE ALSO
Packit 209cc3
pcap(3PCAP), pcap-savefile(@MAN_FILE_FORMATS@)