contrib/libpcap/pcap_set_rfmon.3pcap

   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_SET_RFMON 3PCAP "3 January 2014"
  21 .SH NAME
  22 pcap_set_rfmon \- set monitor mode for a not-yet-activated capture
  23 handle
  24 .SH SYNOPSIS
  25 .nf
  26 .ft B
  27 #include <pcap/pcap.h>
  28 .LP
  29 .ft B
  30 int pcap_set_rfmon(pcap_t *p, int rfmon);
  31 .ft
  32 .fi
  33 .SH DESCRIPTION
  34 .B pcap_set_rfmon()
  35 sets whether monitor mode should be set on a capture handle when
  36 the handle is activated.
  37 If
  38 .I rfmon
  39 is non-zero, monitor mode will be set, otherwise it will not be set.
  40 .SH RETURN VALUE
  41 .B pcap_set_rfmon()
  42 returns 0 on success or
  43 .B PCAP_ERROR_ACTIVATED
  44 if called on a capture handle that has been activated.
  45 .SH SEE ALSO
  46 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
  47 pcap_can_set_rfmon(3PCAP)