From b5b349172683da3b201f17f5adb67fefe5cbc24c Mon Sep 17 00:00:00 2001 From: Alexandre Abadie Date: Sat, 3 Oct 2020 16:03:05 +0200 Subject: [PATCH] doc: add tapsetup note in getting-started page --- doc/doxygen/src/getting-started.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc/doxygen/src/getting-started.md b/doc/doxygen/src/getting-started.md index 831b098dd6..302cab382f 100644 --- a/doc/doxygen/src/getting-started.md +++ b/doc/doxygen/src/getting-started.md @@ -152,3 +152,22 @@ subset of modules). For instructions on how to configure via `CFLAGS` check the @ref config "identified compile-time configurations". To learn how to use Kconfig in RIOT, please refer to the @ref kconfig-users-guide. + +Using the native port with networking +===================================== + +If you compile RIOT for the native cpu and include the `netdev_tap` module, +you can specify a network interface like this: `PORT=tap0 make term` + +Setting up a tap network +------------------------ + +There is a shell script in `RIOT/dist/tools/tapsetup` called `tapsetup` which +you can use to create a network of tap interfaces. + +*USAGE* + +To create a bridge and two (or `count` at your option) tap interfaces: +~~~~~~~{.sh} + sudo ./dist/tools/tapsetup/tapsetup [-c []] +~~~~~~~