zephyr/samples/net/promiscuous_mode
Jukka Rissanen 8b7057c918 samples: net: promiscuous_mode: Add missing README.rst file
The promiscuous mode sample was missing documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-21 16:38:13 -05:00
..
src shell: Modify subcommands to use SHELL_STATIC_SUBCMD_SET_CREATE 2019-02-20 07:31:35 -05:00
CMakeLists.txt cmake: increase minimal required version to 3.13.1 2019-01-03 11:51:29 -05:00
prj.conf samples: net: promiscuous: Convert to new logging system 2018-10-04 14:13:57 +03:00
README.rst samples: net: promiscuous_mode: Add missing README.rst file 2019-02-21 16:38:13 -05:00

.. _net-promiscuous-mode-sample:

Promiscuous Mode Sample Application
###################################

Overview
********

This application will enable promiscuous mode for every network
interface in the system. It will then start to listen for incoming
network packets and show information about them.

The application will also provide a shell so that user can enable
or disable promiscuous mode at runtime. The commands are called
``promisc on`` and ``promisc off``.

Requirements
************

- :ref:`networking_with_host`

Building and Running
********************

There are multiple ways to use this application. In this example QEMU
is used:

.. zephyr-app-commands::
   :zephyr-app: samples/net/promiscuous_mode
   :board: qemu_x86
   :conf: <config file to use>
   :goals: build
   :compact: