mirror of
https://github.com/yarrick/iodine.git
synced 2025-04-11 04:50:55 +00:00
man page
This commit is contained in:
Christopher Schramm
Barak A. Pearlmutter
parent
1d7c33c7cb
commit
e48ff740a7
1 changed files with 36 additions and 6 deletions
42
man/iodine.8
42
man/iodine.8
|
|
@ -11,7 +11,7 @@ iodine, iodined \- tunnel IPv4 over DNS
|
||||||
.I user
|
.I user
|
||||||
.B ] [-P
|
.B ] [-P
|
||||||
.I password
|
.I password
|
||||||
.B ] [-m
|
.B ] [-6] [-7] [-m
|
||||||
.I fragsize
|
.I fragsize
|
||||||
.B ] [-t
|
.B ] [-t
|
||||||
.I chrootdir
|
.I chrootdir
|
||||||
|
|
@ -45,7 +45,7 @@ iodine, iodined \- tunnel IPv4 over DNS
|
||||||
|
|
||||||
.B iodined [-h]
|
.B iodined [-h]
|
||||||
|
|
||||||
.B iodined [-c] [-s] [-f] [-D] [-u
|
.B iodined [-c] [-s] [-f] [-D] [-6] [-7] [-u
|
||||||
.I user
|
.I user
|
||||||
.B ] [-t
|
.B ] [-t
|
||||||
.I chrootdir
|
.I chrootdir
|
||||||
|
|
@ -55,10 +55,14 @@ iodine, iodined \- tunnel IPv4 over DNS
|
||||||
.I mtu
|
.I mtu
|
||||||
.B ] [-l
|
.B ] [-l
|
||||||
.I listen_ip
|
.I listen_ip
|
||||||
|
.B ] [-r
|
||||||
|
.I listen_ip6
|
||||||
.B ] [-p
|
.B ] [-p
|
||||||
.I port
|
.I port
|
||||||
.B ] [-n
|
.B ] [-n
|
||||||
.I external_ip
|
.I external_ip
|
||||||
|
.B ] [-q
|
||||||
|
.I external_ip6
|
||||||
.B ] [-b
|
.B ] [-b
|
||||||
.I dnsport
|
.I dnsport
|
||||||
.B ] [-P
|
.B ] [-P
|
||||||
|
|
@ -72,10 +76,14 @@ iodine, iodined \- tunnel IPv4 over DNS
|
||||||
.B [
|
.B [
|
||||||
.I /netmask
|
.I /netmask
|
||||||
.B ]
|
.B ]
|
||||||
|
.I tunnel_net6
|
||||||
|
.B [
|
||||||
|
.I /netmask6
|
||||||
|
.B ]
|
||||||
.I topdomain
|
.I topdomain
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.B iodine
|
.B iodine
|
||||||
lets you tunnel IPv4 data through a DNS
|
lets you tunnel IPv4 or IPv6 data through a DNS
|
||||||
server. This can be useful in situations where Internet access is firewalled,
|
server. This can be useful in situations where Internet access is firewalled,
|
||||||
but DNS queries are allowed. It needs a TUN/TAP device to operate. The
|
but DNS queries are allowed. It needs a TUN/TAP device to operate. The
|
||||||
bandwidth is asymmetrical,
|
bandwidth is asymmetrical,
|
||||||
|
|
@ -101,6 +109,16 @@ Print version info and exit.
|
||||||
.B -h
|
.B -h
|
||||||
Print usage info and exit.
|
Print usage info and exit.
|
||||||
.TP
|
.TP
|
||||||
|
.B -6
|
||||||
|
Use IPv6. This enbles IPv6 packets to be sent on top of the DNS protocol.
|
||||||
|
Otherwise IPv4 will be used. Make sure to provide this option for both,
|
||||||
|
the client and the server. It is only available on Linux systems.
|
||||||
|
.TP
|
||||||
|
.B -7
|
||||||
|
Establish tunnel using IPv6. This enables the DNS packets to be sent on top
|
||||||
|
of IPv6. Otherwise IPv4 will be used. Make sure to provide this option for both,
|
||||||
|
the client and the server. It is only available on Linux systems.
|
||||||
|
.TP
|
||||||
.B -f
|
.B -f
|
||||||
Keep running in foreground.
|
Keep running in foreground.
|
||||||
.TP
|
.TP
|
||||||
|
|
@ -251,15 +269,23 @@ automatically fragmented when needed.
|
||||||
.TP
|
.TP
|
||||||
.B -l listen_ip
|
.B -l listen_ip
|
||||||
Make the server listen only on 'listen_ip' for incoming requests.
|
Make the server listen only on 'listen_ip' for incoming requests.
|
||||||
|
Use -r to provide an IPv6 address.
|
||||||
By default, incoming requests are accepted from all interfaces.
|
By default, incoming requests are accepted from all interfaces.
|
||||||
.TP
|
.TP
|
||||||
|
.B -r listen_ip6
|
||||||
|
Make the server listen only on 'listen_ip6' for incoming requests.
|
||||||
|
.TP
|
||||||
.B -p port
|
.B -p port
|
||||||
Make the server listen on 'port' instead of 53 for traffic.
|
Make the server listen on 'port' instead of 53 for traffic.
|
||||||
.B Note:
|
.B Note:
|
||||||
You must make sure the dns requests are forwarded to this port yourself.
|
You must make sure the dns requests are forwarded to this port yourself.
|
||||||
.TP
|
.TP
|
||||||
.B -n external_ip
|
.B -n external_ip
|
||||||
The IP address to return in NS responses. Default is to return the address used
|
The IPv4 address to return in NS responses. Default is to return the address used
|
||||||
|
as destination in the query.
|
||||||
|
.TP
|
||||||
|
.B -q external_ip6
|
||||||
|
The IPv6 address to return in NS responses. Default is to return the address used
|
||||||
as destination in the query.
|
as destination in the query.
|
||||||
.TP
|
.TP
|
||||||
.B -b dnsport
|
.B -b dnsport
|
||||||
|
|
@ -288,11 +314,15 @@ must be the same on both the client and the server.
|
||||||
.SS Server Arguments:
|
.SS Server Arguments:
|
||||||
.TP
|
.TP
|
||||||
.B tunnel_ip[/netmask]
|
.B tunnel_ip[/netmask]
|
||||||
This is the server's ip address on the tun interface. The client will be
|
This is the server's IPv4 address on the tun interface. The client will be
|
||||||
given the next ip number in the range. It is recommended to use the
|
given the next IPv4 number in the range. It is recommended to use the
|
||||||
10.0.0.0 or 172.16.0.0 ranges. The default netmask is /27, can be overriden
|
10.0.0.0 or 172.16.0.0 ranges. The default netmask is /27, can be overriden
|
||||||
by specifying it here. Using a smaller network will limit the number of
|
by specifying it here. Using a smaller network will limit the number of
|
||||||
concurrent users.
|
concurrent users.
|
||||||
|
.B tunnel_net6/netmask6
|
||||||
|
This is the server's IPv6 network address on the tun interface. The client will be
|
||||||
|
given an IPV6 number from this range. Using a smaller network will limit the number of
|
||||||
|
concurrent users.
|
||||||
.TP
|
.TP
|
||||||
.B topdomain
|
.B topdomain
|
||||||
The dns traffic is expected to arrive as queries for
|
The dns traffic is expected to arrive as queries for
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue