From: Ralph Ronnquist Date: Sun, 30 Apr 2023 13:59:00 +0000 (+1000) Subject: uppercase X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=cb80553f312ac382170b31e4ff83a056c45efd11;p=rrq%2Frrqnet.git uppercase --- diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..f216a2f --- /dev/null +++ b/README.adoc @@ -0,0 +1,53 @@ +About rrqnet +============ + +This repository holds the sources for *rrqnet*, which provides 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/src/branch/suites/unstable/rrqnet.8.adoc[The rrqnet man page] + * link:rrqnet/src/branch/suites/unstable/rrqnet-ifupdown.sh.8.adoc[The rrqnet-ifupdown.sh man page] + * link:rrqnet/src/branch/suites/unstable/rrqnet-cron.8.adoc[The rrqnet-cron 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* for cron based persistence with bespoke configuration + * *rrqnet-ifupdown.sh* for adminstraion via *ifupdown* + diff --git a/readme.adoc b/readme.adoc deleted file mode 100644 index f216a2f..0000000 --- a/readme.adoc +++ /dev/null @@ -1,53 +0,0 @@ -About rrqnet -============ - -This repository holds the sources for *rrqnet*, which provides 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/src/branch/suites/unstable/rrqnet.8.adoc[The rrqnet man page] - * link:rrqnet/src/branch/suites/unstable/rrqnet-ifupdown.sh.8.adoc[The rrqnet-ifupdown.sh man page] - * link:rrqnet/src/branch/suites/unstable/rrqnet-cron.8.adoc[The rrqnet-cron 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* for cron based persistence with bespoke configuration - * *rrqnet-ifupdown.sh* for adminstraion via *ifupdown* -