zephyr

History

Benjamin Cabé 994558ef8e samples: net: doc: Use new Sphinx extension to document networking samples Use the new code-sample directive and roles to document the networking samples so that they show up as "Related samples" when browsing the various relevant networking APIs. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2023-09-19 15:22:59 +01:00
..
src	…
CMakeLists.txt	…
README.rst	samples: net: doc: Use new Sphinx extension to document networking samples	2023-09-19 15:22:59 +01:00
prj.conf	…
sample.yaml	…

README.rst

.. zephyr:code-sample:: net-promiscuous-mode
   :name: Promiscuous mode
   :relevant-api: promiscuous

   Enable promiscuous mode on all interfaces and print information about incoming packets.

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: