contrib/libpcap/pcap_compile.3pcap.in

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_compile.3pcap.in,v 1.1 2008-10-21 07:33:02 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_COMPILE 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_compile \- compile a filter expression
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .LP
  31 .ft B
  32 int pcap_compile(pcap_t *p, struct bpf_program *fp,
  33 .ti +8
  34 const char *str, int optimize, bpf_u_int32 netmask);
  35 .ft
  36 .fi
  37 .SH DESCRIPTION
  38 .B pcap_compile()
  39 is used to compile the string
  40 .I str
  41 into a filter program.  See
  42 .BR pcap-filter (@MAN_MISC_INFO@)
  43 for the syntax of that string.
  44 .I program
  45 is a pointer to a
  46 .I bpf_program
  47 struct and is filled in by
  48 .BR pcap_compile() .
  49 .I optimize
  50 controls whether optimization on the resulting code is performed.
  51 .I netmask
  52 specifies the IPv4 netmask of the network on which packets are being
  53 captured; it is used only when checking for IPv4 broadcast addresses in
  54 the filter program.  If the netmask of the network on which packets are
  55 being captured isn't known to the program, or if packets are being
  56 captured on the Linux "any" pseudo-interface that can capture on more
  57 than one network, a value of PCAP_NETMASK_UNKNOWN can be supplied; tests
  58 for IPv4 broadcast addresses will fail to compile, but all other tests in
  59 the filter program will be OK.
  60 .SH RETURN VALUE
  61 .B pcap_compile()
  62 returns 0 on success and \-1 on failure.
  63 If \-1 is returned,
  64 .B pcap_geterr()
  65 or
  66 .B pcap_perror()
  67 may be called with
  68 .I p
  69 as an argument to fetch or display the error text.
  70 .SH SEE ALSO
  71 pcap(3PCAP), pcap_setfilter(3PCAP), pcap_freecode(3PCAP),
  72 pcap_geterr(3PCAP), pcap-filter(@MAN_MISC_INFO@)