xl2tpd: README.md: add docs on uci options

Signed-off-by: Yousong Zhou <yszhou4tech@gmail.com>

2 files changed, 45 insertions, 23 deletions

diff --git a/net/xl2tpd/README b/net/xl2tpd/README
deleted file mode 100644
index aadc26e4e..000000000
--- a/net/xl2tpd/README
+++ /dev/null
@@ -1,23 +0,0 @@
-OpenWRT Package for xl2tpd
-
-xl2tpd is a development from the original l2tpd package originally written by
-Mark Spencer, subsequently forked by Scott Balmos and David Stipp, inherited
-by Jeff McAdams, modified substantially by Jacco de Leeuw and then forked 
-again by Xelerance (after it was abandoned by l2tpd.org).
-
-Rationale for inclusion in OpenWRT:
-
-l2tpd has some serious alignment problems on RISC platforms. It also runs 
-purely in userspace.
-
-Some of the features added in this fork include:
-
-1. IPSec SA reference tracking inconjunction with openswan's IPSec transport
-   mode, which adds support for multiple clients behind the same NAT router
-	 and multiple clients on the same internal IP behind different NAT routers.
-
-2. Support for the pppol2tp kernel mode L2TP.
-
-3. Alignment and endian problems resolved.
-
-hcg
diff --git a/net/xl2tpd/README.md b/net/xl2tpd/README.md
new file mode 100644
index 000000000..ea8a6e2ca
--- /dev/null
+++ b/net/xl2tpd/README.md
@@ -0,0 +1,45 @@
+# OpenWrt Package for xl2tpd
+
+xl2tpd is a development from the original l2tpd package originally written by
+Mark Spencer, subsequently forked by Scott Balmos and David Stipp, inherited
+by Jeff McAdams, modified substantially by Jacco de Leeuw and then forked
+again by Xelerance (after it was abandoned by l2tpd.org).
+
+## Rationale for inclusion in OpenWrt
+
+l2tpd has some serious alignment problems on RISC platforms. It also runs
+purely in userspace.
+
+Some of the features added in this fork include:
+
+1. IPSec SA reference tracking inconjunction with openswan's IPSec transport
+   mode, which adds support for multiple clients behind the same NAT router
+   and multiple clients on the same internal IP behind different NAT routers.
+
+2. Support for the pppol2tp kernel mode L2TP.
+
+3. Alignment and endian problems resolved.
+
+hcg
+
+## UCI options
+
+`server` takes the form `host[:port]` with port defaults to `1701`.  It
+specifies the l2tp server's address.
+
+`checkup_interval` tells netifd to check after that many seconds since last
+setup attempt to see if the interface is up.  If not it should issue another
+teardown/setup round to retry the negotiation.  This option defaults to 0 and
+netifd will not do the check and retry.
+
+The following are generic ppp options and should have the same format and
+semantics as with other ppp-related protocols.  See
+[uci/network#protocol_ppp](https://wiki.openwrt.org/doc/uci/network#protocol_ppp_ppp_over_modem)
+for details.
+
+	username
+	password
+	keepalive
+	ipv6
+	mtu
+	pppd_options