From: Arran Cudbard-Bell <a.cudbardb@freeradius.org>
Date: Sat, 2 Feb 2019 09:32:50 +0000 (+0800)
Subject: Minor doc tweaks
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5ce36d0effafa2f5ce5ccce6d330ca5e9ffb45d5;p=thirdparty%2Ffreeradius-server.git

Minor doc tweaks
---

diff --git a/raddb/mods-available/ippool b/raddb/mods-available/ippool
index 575376f4531..a5ed0dd9e38 100644
--- a/raddb/mods-available/ippool
+++ b/raddb/mods-available/ippool
@@ -28,13 +28,13 @@
 #  [source, unlang]
 #  ----
 #  ippool students { [...] }
-#  
+#
 #  ippool teachers { [...] }
 #  ----
 #
 #  <2> Then the `raddb/users` should have.
 #
-#  [source, unlang]
+#  [source, rlm_users]
 #  ----
 #  DEFAULT Group == students, Pool-Name := "students"
 #  DEFAULT Group == teachers, Pool-Name := "teachers"
@@ -87,7 +87,7 @@ ippool main_pool {
 
 	#
 	#  maximum_timeout:: Specifies the maximum time in seconds that an entry
-	#  may be active.  If set to zero, means _no timeout_. 
+	#  may be active.  If set to zero, means _no timeout_.
 	#  The default value is 0
 	#
 	maximum_timeout = 0
diff --git a/raddb/mods-available/krb5 b/raddb/mods-available/krb5
index f65fb05c035..d0cf7beeb4d 100644
--- a/raddb/mods-available/krb5
+++ b/raddb/mods-available/krb5
@@ -10,7 +10,7 @@
 #
 #  The `krb5` module enables the use of Kerberos 5 for authentication.
 #
-#  NOTE: By default, presumes you have the MIT Kerberos 5 distribution.
+#  NOTE: This default config presumes you have the MIT Kerberos 5 distribution.
 #
 #  ## Default instance
 #
@@ -121,24 +121,25 @@ krb5 {
 #
 #  You can configure the module with the following parameters:
 #
-#  ```
-#    krb5 {
-#        # Keytab containing the key used by rlm_krb5
-#        keytab = /path/to/keytab
+# [source, unlang]
+# ----
+# krb5 {
+# 	# Keytab containing the key used by rlm_krb5
+# 	keytab = /path/to/keytab
 #
-#        # Principal that is used by rlm_krb5
-#        service_principal = radius/some.host.com
-#    }
-#  ```
+# 	# Principal that is used by rlm_krb5
+# 	service_principal = radius/some.host.com
+# }
+# ----
 #
 #  Make sure the keytab is readable by the user that is used to run `radiusd` and
 #  that your authorization configuration really uses `krb5` to do the
 #  authentication. You will need to add the following to the `authenticate`
 #  section of your `radiusd.conf` file:
 #
-#  ```
-#    Auth-Type Kerberos {
-#        krb5
-#    }
-#  ```
+# [source, unlang]
+# Auth-Type Kerberos {
+# 	krb5
+# }
+# ----
 #
diff --git a/raddb/mods-available/ldap b/raddb/mods-available/ldap
index 805bca51daf..a7bbe1e441c 100644
--- a/raddb/mods-available/ldap
+++ b/raddb/mods-available/ldap
@@ -113,7 +113,7 @@ ldap {
 		# mech:: SASL mechanism.
 		#
 #		mech = 'PLAIN'
-		
+
 		#
 		# proxy:: SASL authorisation identity to proxy.
 		#
@@ -166,7 +166,7 @@ ldap {
 	#  [options="header,autowidth"]
 	#  |===
 	#  | Parameter   | Description
-	#  | <fr attr>   | Is the destination RADIUS attribute 
+	#  | <fr attr>   | Is the destination RADIUS attribute
 	#                  with any valid list and request qualifiers.
 	#  | <op>        | Is any assignment attribute (=, :=, +=, -=).
 	#  | <ldap attr> | Is the attribute associated with user or
@@ -221,14 +221,15 @@ ldap {
 	#
 	#  e.g:
 	#
-	#  ```
-	#    ldap
-	#    if ((ok || updated) && User-Password) {
-	#        update {
-	#            control:Auth-Type := ldap
-	#        }
-	#    }
-	#  ```
+	#  [source, unlang]
+	#  ----
+	#  ldap
+	#  if ((ok || updated) && User-Password) {
+	#  	update {
+	#  		control:Auth-Type := ldap
+	#  	}
+	#  }
+	#  ----
 	#  ====
 	#
 
@@ -562,7 +563,7 @@ ldap {
 		#  session_tracking:: If `yes`, then include `draft-wahl-ldap-session` tracking
 		#  controls.
 		#
-		#  These encode the `NAS-IP-Address`, `NAS-IPv6-Address`, `User-Name`, `Acct-Session-Id`, 
+		#  These encode the `NAS-IP-Address`, `NAS-IPv6-Address`, `User-Name`, `Acct-Session-Id`,
 		#  `Acct-Multi-Session-Id` as session tracking controls, in applicable LDAP operations.
 		#
 		#  Default `no`
@@ -619,10 +620,10 @@ ldap {
 		interval = 3
 
 		#
-		#  ldap_debug:: Debug flag for LDAP SDK (see OpenLDAP documentation).
-		#  Set this to enable huge amounts of LDAP debugging on the screen.
+		#  ldap_debug:: Debug flags for libldap (see OpenLDAP documentation).
+		#  Set this to enable debugging output from different code areas within libldap.
 		#
-		#  TIP: You should only use this if you are an LDAP expert.
+		#  NOTE: These debugging options can produce significant amounts of logging output.
 		#
 		#  [options="header,autowidth"]
 		#  |===
@@ -647,16 +648,16 @@ ldap {
 		#  e.g:
 		#
 		#  If you want to see the LDAP logs only for `trace` and `parse`,
-		#  you should do:
+		#  facilities you should use:
 		#
 		#    (LDAP_DEBUG_TRACE + LDAP_DEBUG_PARSE) = 0x0801
 		#
-		#  Then, fill the option `ldap_debug`.
+		#  Setting the `ldap_debug` configuration item as follows:
 		#
 		#     ldap_debug = 0x0801
 		#
 		#  Default: 0x0000 (no debugging messages)
-		#  
+		#
 		ldap_debug = 0x0000
 	}
 
@@ -690,7 +691,7 @@ ldap {
 
 		#
 		# require_cert:: Certificate Verification requirements.
-		# 
+		#
 		# Can be:
 		#
 		#  [options="header,autowidth"]