Browse Source

doc: updated and clarified tapsetup usage

pr/gpio
Oleg Hahm 7 years ago
parent
commit
8e6dc1a03f
  1. 2
      README.md
  2. 17
      cpu/native/README.md
  3. 3
      doc/doxygen/src/mainpage.md

2
README.md

@ -50,7 +50,7 @@ Its features comprise
* The RIOT API itself can be built from the code using doxygen. The latest version is uploaded daily to http://riot-os.org/api.
### USING THE NATIVE PORT WITH NETWORKING
If you compile RIOT for the native cpu and include the gnrc_netif_default module, you can specify a network interface like this: `PORT=tap0 make term`
If you compile RIOT for the native cpu and include the `netdev2_tap` module, you can specify a network interface like this: `PORT=tap0 make term`
#### SETTING UP A TAP NETWORK
There is a shellscript in `RIOT/dist/tools/tapsetup` called `tapsetup` which you can use to create a network of tap interfaces.

17
cpu/native/README.md

@ -34,14 +34,18 @@ server (vgdb).
Network Support
===============
If you compile RIOT for the native cpu and include the `native_net`
If you compile RIOT for the native cpu and include the `netdev2_tap`
module, you need to specify a network interface like this:
make term PORT=tap0
**Please note:** in case you're using RIOT's default network stack, the GNRC
stack, you may also use `gnrc_netif_default` module and also add
`auto_init_gnrc_netif` in order to automatically initialize the interface.
Setting Up A Tap Network
========================
Setting Up A Virtual Network
============================
There is a shellscript in RIOT/dist/tools/tapsetup called `tapsetup` which you
can use to create a network of tap interfaces.
@ -61,6 +65,13 @@ To delete the bridge and all tap interfaces:
For OSX you **have** to run this after killing your RIOT instance and rerun
`../../dist/tools/tapsetup [-c [<count>]]` before restarting.
**Please note:** If you want to communicate between RIOT and your host
operating system, you must not use the `tapsetup` script, but create and
activate the tap interface manually. On Linux you can do so, by calling
sudo ip tuntap add tap0 mode tap user ${USER}
sudo ip link set tap0 up
Daemonization
=============

3
doc/doxygen/src/mainpage.md

@ -57,7 +57,8 @@ git clone git://github.com/RIOT-OS/RIOT.git # assumption: git is pre-installed
git checkout <LATEST_RELEASE>
cd RIOT
./dist/tools/tapsetup/tapsetup # create virtual Ethernet
# interfaces to connect to RIOT
# interfaces to connect multiple
# RIOT instances
cd examples/default/
make all
make term

Loading…
Cancel
Save