[Pkg-vsquare-changes] r244 - vde2/trunk/debian

[Filippo Giunchedi]

Author: filippo
Date: 2010-07-03 16:14:44 +0000 (Sat, 03 Jul 2010)
New Revision: 244

Modified:
   vde2/trunk/debian/README.Debian
Log:
update README.debian with some fixes/typos

Modified: vde2/trunk/debian/README.Debian
===================================================================
--- vde2/trunk/debian/README.Debian	2009-09-06 16:00:31 UTC (rev 243)
+++ vde2/trunk/debian/README.Debian	2010-07-03 16:14:44 UTC (rev 244)
@@ -4,16 +4,16 @@
 ifupdown usage
 ==============
 
-The Debian package provides an extension for iface sections in
+The Debian package provides an extension for ``iface`` sections in
 ``/etc/network/interfaces`` file:
 
-vde2-switch - | <parameters> 
+vde2-switch - | <parameters>
 
   Start TAP interface with ``vde_switch`` command which has control directory
   ``/var/run/vde/$IFACE.ctl``. The control directory is writable by vde2-net
   group. The additional parameters might be --macaddr MAC for switch MAC
   address or other parameters. See ``vde_switch --help`` or vde_switch(1) for
-  further informations.
+  further information.
 
   When using the ``manual`` method of ifupdown no further setup is made, thus
   it is possible to connect only the unix socket, e.g.::
@@ -23,9 +23,9 @@
         vde2-switch -
 
   starts a ``vde_switch`` on virtual interface ``vde0`` (not TAP!) at every
-  boot, see ifup(8). 
-  In this case ``vde0`` is used only for future reference, for example management
-  socket can be accessed from ``/var/run/vde2/vde0.mgmt``
+  boot, see ifup(8).
+  In this case ``vde0`` is used only for future reference, for example
+  management socket can be accessed from ``/var/run/vde2/vde0.mgmt``
 
   It might be also convenient to attach a ``vde_switch`` to a TAP on boot to
   use for bridging, in this case you should specify the TAP interface because
@@ -42,20 +42,21 @@
   specify the network address (default 10.0.2.0).
   See ``slirpvde --help`` for description.
 
-  Please note that slirp is a virtual router for VDE, it is commonly used
-  as a mean to connect the virtual network to the outside world.
-  Slirp does not require root access, kernel ip forwarding or iptables
-  configuration. TAP however requires root access, providing any kind of routing
-  like a real interface and it is also faster.
+  Please note that slirp is a virtual router for VDE, it is commonly used as a
+  mean to connect the virtual network to the outside world.  Slirp does not
+  require root access, kernel ip forwarding or iptables configuration. TAP
+  however requires root access, providing any kind of routing like a real
+  interface and it is also faster.
 
-  Do not use TAP and slirp together in the same VDE LAN unless 
-  you know exactly what you are doing. If you set up a slirp with DHCP
-  on a TAP and you autoconfigure the interface it will become the
-  default route for the entire system.
+  Do not use TAP and slirp together in the same VDE LAN unless you know exactly
+  what you are doing. If you set up a slirp with DHCP on a TAP and you
+  autoconfigure the interface it will become the default route for the entire
+  system.
 
 vde2-plug <dpipe_arg2>
+
   Start ``dpipe`` connecting a ``vde_plug`` with the given ``dpipe_arg2`` as
-  the second argument after =. See ``dpipe`` man page for further details. 
+  the second argument after =. See ``dpipe`` man page for further details.
   For example it is possible to connect two local plugs::
 
     vde2-plug vde_plug /tmp/vde2.ctl
@@ -66,26 +67,27 @@
 
     vde2-plug ssh remote.machine.org vde_plug /var/run/vde2/tap0.ctl
 
-  connects the given TAP interface to remote ``vde_switch`` using ssh to encrypt the traffic.
+  connects the given TAP interface to remote ``vde_switch`` using ssh to
+  encrypt the traffic.
 
 Commandline usage
 =================
 
 The encrypted tunnel
 --------------------
-  
+
 The VDE is the simplest VPN solution.
-  
+
 On local system::
-  
+
   iface tap0 inet static
       address 10.0.2.2
       netmask 255.255.255.0
       vde2-switch -
       vde2-plug ssh user at remote.machine.org vde_plug /var/run/vde2/tap0.ctl
-                    
+
 On remote system::
-  
+
   iface tap0 inet static
       address 10.0.2.1
       netmask 255.255.255.0
@@ -93,9 +95,9 @@
 
 If ``vde2-slirp`` option is used, the connection works without NAT. The VDE can
 be also started with non-root privileges on the remote machine.
-  
+
 On local system::
-  
+
   iface tap0 inet dhcp
     vde2-switch -
     pre-up ssh user at remote.machine.org vde_switch -s /tmp/vde.ctl -p /tmp/vde_switch.pid -d
@@ -167,14 +169,14 @@
     END
 
 5. Check if the systems are available::
-  
+
     # ping 10.0.3.101
     # ping 10.0.3.102
 
 6. Configure the routing/masquerading/bridging on the host computer
    for ``tap0`` as you do on any other interface.
 
-QEMU-Slirp 
+QEMU-Slirp
 ----------
 
 1. Configure vde0::
@@ -270,7 +272,8 @@
 
   where ``tap0`` is the name of the interface.
 
-Authors::
+Authors
+-------
 
-  -- Piotr Roszatycki <dexter at debian.org>  Thu, 14 Dec 2006 10:22:19 +0100
-  -- Renzo Davoli <renzo at cs.unibo.it>  Fri Apr 20 2007 19:33:27 +0200
+  * Piotr Roszatycki <dexter at debian.org>  Thu, 14 Dec 2006 10:22:19 +0100
+  * Renzo Davoli <renzo at cs.unibo.it>  Fri Apr 20 2007 19:33:27 +0200