From: Alan T. DeKok <aland@freeradius.org>
Date: Sun, 11 Aug 2019 13:51:46 +0000 (-0400)
Subject: add documentation
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7daf37781ea3328ceacf862428cfb1d9ed772829;p=thirdparty%2Ffreeradius-server.git

add documentation
---

diff --git a/doc/unlang/detach.adoc b/doc/unlang/detach.adoc
new file mode 100644
index 00000000000..b556aa0ee9c
--- /dev/null
+++ b/doc/unlang/detach.adoc
@@ -0,0 +1,36 @@
+
+== The detach Statement
+
+.Syntax
+[source,unlang]
+----
+detach
+----
+
+The `detach` statement is used to separare a child request from a
+parent request.  The `detach` statement can only be used inside of a
+link:subrequest.adoc[subrequest] section.
+
+Once a child request is detached from the parent, the parent can
+continue execution independently of the child.  However, once a child
+request is detached from the parent request, the child can no longer
+access any attributes in the parent.
+
+.Example
+[source,unlang]
+----
+subrequest Disconnect-Request {
+    update request {
+        &User-Name := &parent.request:User-Name
+        &NAS-IP-Address := &parent.request:NAS-IP-Address
+        &NAS-Port := &parent.request:NAS-Port
+        &Acct-Session-Id := &parent.request:Acct-Session-Id
+    }
+
+    detach
+    radius
+}
+----
+
+// Copyright (C) 2019 Network RADIUS SAS.  Licenced under CC-by-NC 4.0.
+// Development of this documentation was sponsored by Network RADIUS SAS.