Skip to content

Commit

Permalink
Modify the documentation section of the README
Browse files Browse the repository at this point in the history
  • Loading branch information
montag451 committed Jan 19, 2014
1 parent fda1df6 commit f3a4420
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,6 @@ You can get/set some parameters of the device directly::
tun.netmask = '255.255.255.0'
tun.mtu = 1500

To read/write to the device, use the methods ``read(size)`` and
``write(buf)``::

buf = tun.read(tun.mtu)
tun.write(buf)

If the device is a TAP you can also get/set its MAC address::

tap.hwaddr = '\x00\x11\x22\x33\x44\x55'
Expand All @@ -68,6 +62,12 @@ To bring down the device::

tun.down()

To read/write to the device, use the methods ``read(size)`` and
``write(buf)``::

buf = tun.read(tun.mtu)
tun.write(buf)

To close the device::

tun.close()
Expand Down

0 comments on commit f3a4420

Please sign in to comment.