Permalink
Browse files

Added some more documentation to the userspace app's manual.

  • Loading branch information...
ydahhrk committed Jun 26, 2014
1 parent 160ffa2 commit 54fc02dd5f5a22c44ac2d6be092306c34abd30ee
Showing with 13 additions and 1 deletion.
  1. +13 −1 doc/usr/userspace-app.markdown
@@ -98,6 +98,8 @@ Interacts with Jool's IPv4 pool. The pool dictates which packets coming from the
* Using `--add`, Jool adds `<IPv4 address>` to the pool.
* Using `--remove`, Jool deletes `<IPv4 address>` from the pool.
When you remove an address, its [BIB entries](#bib) are also removed from their respective tables. BIB entry _B_ belongs to pool address _A_ if _B_'s IPv4 address equals _A_.
**Examples**
{% highlight bash %}
@@ -152,7 +154,9 @@ The database consists of three separate tables; one for TCP bindings, one for UD
* Using `--display`, the application prints Jool's current BIB. `--bib6` and `--bib4` are ignored. This is the default operation.
* Using `--count`, Jool prints the number of BIB entries per table. `--bib6` and `--bib4` are ignored.
* Using `--add`, Jool adds the entry resulting from the `--bib6` and `--bib4` parameters to the BIB. Note that the `--bib4` component is an address assigned to the NAT64, so make sure you have added it to the [IPv4 pool](#pool4).
* Using `--remove`, Jool deletes the entry. Since both components are unique across all entries from the same table, you only need to supply one of the --bib* arguments.
* Using `--remove`, Jool deletes the entry. Since both components are unique across all entries from the same table, you only need to supply one of the `--bib*` arguments.
When you delete a BIB entry, its [sessions](#session) are also removed from their respective tables. Session entry _S_ belongs to BIB entry _B_ if _S_'s local IPv4 transport address equals _B_'s IPv4 transport address, and _S_'s remote IPv6 transport address equals _B_'s IPv6 transport address.
**Protocols**
@@ -334,6 +338,8 @@ Similar to `--dropAddr`, except it only affects TCP packets.
When a UDP session has been lying around inactive for this long, its entry will be removed from the database automatically.
When you change this value, the lifetimes of all already existing UDP sessions are updated.
### \--toTCPest
- Name: TCP established session lifetime
@@ -342,6 +348,8 @@ When a UDP session has been lying around inactive for this long, its entry will
When an established TCP connection has remained inactive for this long, its existence will be questioned. Jool will send a probe packet to one of the endpoints and kill the session if a response is not received before the `--toTCPtrans` timeout.
When you change this value, the lifetimes of all already existing established TCP sessions are updated.
### \--toTCPtrans
- Name: TCP transitory session lifetime
@@ -350,6 +358,8 @@ When an established TCP connection has remained inactive for this long, its exis
When a unhealthy TCP session has been lying around inactive for this long, its entry will be removed from the database automatically. A "unhealthy" session is one in which the TCP handshake has not yet been completed, it is being terminated by the endpoints, or is technically established but has remained inactive for `--toTCPest` time.
When you change this value, the lifetimes of all already existing transitory TCP sessions are updated.
### \--toICMP
- Name: ICMP session lifetime
@@ -358,6 +368,8 @@ When a unhealthy TCP session has been lying around inactive for this long, its e
When a ICMP session has been lying around inactive for this long, its entry will be removed from the database automatically.
When you change this value, the lifetimes of all already existing ICMP sessions are updated.
## \--translate
**Syntax**

0 comments on commit 54fc02d

Please sign in to comment.