About rrqnet
============

This repository holds the sources for *rrqnet*, which concern VPN
building over UDP transport. *rrqnet* operates at Ethernet level and
transports both ipv4 and ipv6. It can thus be used for all
combinations of ipv4 and ipv6 tunneling over ipv4 or ipv6.

MAN PAGES
---------
  * link:rrqnet.8.adoc[The rrqnet man page]
  * link:rrqnet-cron.sh.8.adoc[The rrqnet-cron.sh man page]
  * link:rrqnet-ifupdown.sh.8.adoc[The rrqnet-ifupdown.sh man page]

Devuan Packages
---------------

  * The *rrqnet* package contains the binaries and their man pages,
as well as the utility scripting.

Doing it by hand
----------------


Building
~~~~~~~~

.make
[caption='Command {counter:Command}: ']
====
This command builds the static executable *rrqnet* and documentation
as "man" pages and HTML formats (using asciidoc).
====

.make rrqnet
[caption='Command {counter:Command}: ']
====
This command builds only the static executable *rrqnet*.
====

Installing
~~~~~~~~~~

The executable (*rrqnet*) should be installed as a system executable
that in particular needs to be able to use network interfaces and
(usually) create a tap.

There are two helper scripts for adminstrating *rrqnet* virtual
cabling:

  * *rrqnet-cron.sh* for cron based persistence with bespoke configuration
  * *rrqnet-ifupdown.sh* for adminstraion via *ifupdown*