summaryrefslogtreecommitdiffstats
path: root/share/man/man4/tun.4
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/man4/tun.4')
-rw-r--r--share/man/man4/tun.434
1 files changed, 12 insertions, 22 deletions
diff --git a/share/man/man4/tun.4 b/share/man/man4/tun.4
index 76fa90a..768bc35 100644
--- a/share/man/man4/tun.4
+++ b/share/man/man4/tun.4
@@ -28,12 +28,10 @@ driver, like the
.Nm pty
driver, provides two interfaces: an interface like the usual facility
it is simulating
-.Po
-a network interface in the case of
+(a network interface in the case of
.Nm ,
or a terminal for
-.Nm pty
-.Pc ,
+.Nm pty ) ,
and a character-special device
.Dq control
interface.
@@ -56,11 +54,9 @@ like any other interface. At boot time, they are
interfaces, but this can be changed; see the description of the control
device, below. When the system chooses to transmit a packet on the
network interface, the packet can be read from the control device
-.Po
-it appears as
+(it appears as
.Dq input
-there
-.Pc ;
+there);
writing a packet to the control device generates an input
packet on the network interface, as if the
.Pq non-existent
@@ -69,9 +65,7 @@ hardware had just received it.
The tunnel device, normally
.Pa /dev/tun Ns Sy N ,
is exclusive-open
-.Po
-it cannot be opened if it is already open
-.Pc
+(it cannot be opened if it is already open)
and is restricted to the super-user.
A
.Fn read
@@ -79,10 +73,8 @@ call will return an error
.Pq Er EHOSTDOWN
if the interface is not
.Dq ready
-.Po
-which means that the control device is open and the interface's
-address has been set
-.Pc .
+(which means that the control device is open and the interface's
+address has been set).
Once the interface is ready,
.Fn read
will return a packet if one is available; if not, it will either block
@@ -197,11 +189,10 @@ value is or isn't zero
.Pq Writes are always nonblocking .
.It Dv FIOASYNC
Turn asynchronous I/O for reads
-.Po
-i.e., generation of
+(i.e., generation of
.Dv SIGIO
-when data is available to be read
-.Pc off or on, according as the argument
+when data is available to be read)
+off or on, according as the argument
.Va int Ns 's
value is or isn't zero.
.It Dv FIONREAD
@@ -230,9 +221,8 @@ writes are always non-blocking.
.Pp
On the last close of the data device, by default, the interface is
brought down
-.Po as if with
-.Dq ifconfig tun Ns Sy n No down
-.Pc .
+(as if with
+.Dq ifconfig tun Ns Sy n No down ) .
All queued packets are thrown away.
If the interface is up when the data device is not open
output packets are always thrown away rather than letting
OpenPOWER on IntegriCloud