From: Jorge Pereira Date: Thu, 31 Jan 2019 01:34:33 +0000 (-0200) Subject: Fix the asciidoc title X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=26a4e1b124ef6eb0fbeaffe230757244f9eaa954;p=thirdparty%2Ffreeradius-server.git Fix the asciidoc title --- diff --git a/raddb/mods-available/abfab_psk_sql b/raddb/mods-available/abfab_psk_sql index 22a4767a005..91e387d39b5 100644 --- a/raddb/mods-available/abfab_psk_sql +++ b/raddb/mods-available/abfab_psk_sql @@ -2,15 +2,17 @@ # # :toc: # -# $Id$ +# $Id$ ####################################################################### # -# ## ADFAB PSK Module +# = ADFAB PSK Module # -# The `abfab_psk_sql` module is used to authorize PSK from `ABFAB` trust router. +# The `abfab_psk_sql` module is used to authorize PSK from `ABFAB` trust router. # -# ## Default instance + +# +# ## Default instance # # @@ -20,7 +22,7 @@ sql psksql { # # driver:: Database driver. # - driver = "rlm_sql_sqlite" + driver = "rlm_sql_sqlite" # # sqlite { ... }:: Database statement based on `driver` setting. diff --git a/raddb/mods-available/always b/raddb/mods-available/always index 89101f5b4b7..df4d473a816 100644 --- a/raddb/mods-available/always +++ b/raddb/mods-available/always @@ -6,16 +6,11 @@ ####################################################################### # -# ## Always Module +# = Always Module # # The `always` module simply returns the same result, always, without # doing anything else. It is here for use in complex policies. # - -# -# ## Sample configuration -# - #always { # # rcode:: Return code. @@ -58,7 +53,7 @@ #} # -# ### Default instances +# ## Default instances # # The following default instances allow the use of return codes like # `reject` or `ok` in `unlang` policies. diff --git a/raddb/mods-available/attr_filter b/raddb/mods-available/attr_filter index 777fda40da7..af93f8b2ed7 100644 --- a/raddb/mods-available/attr_filter +++ b/raddb/mods-available/attr_filter @@ -6,15 +6,10 @@ ####################################################################### # -# ## Attr_filter Module +# = Attr_filter Module # # The `attr_filter` module defines a number of instances of the "attr_filter". # - -# -# ## Sample configuration -# - #attr_filter attr_filter.
{ # # key:: @@ -31,7 +26,7 @@ # filename =
#} -# ## Default instances +# ## Default instances # # The following default instances. diff --git a/raddb/mods-available/cache b/raddb/mods-available/cache index ff40d42b8c9..1116ae3896b 100644 --- a/raddb/mods-available/cache +++ b/raddb/mods-available/cache @@ -6,7 +6,7 @@ ####################################################################### # -# ## Cache Module +# = Cache Module # # The `cache` module is used to cache attributes. The idea is that you can look # up information in a database, and then cache it. Repeated requests for the same @@ -63,9 +63,10 @@ cache { # # ### Memcached cache driver +# # memcached { # - # options:: Memcached configuration options. + # options:: Memcached configuration options. # # The memcached options are documented at # http://docs.libmemcached.org/libmemcached_configuration.html#memcached @@ -88,9 +89,10 @@ cache { # # ### Redis cache driver +# # redis { # - # server:: Redis Server name. + # server:: Redis Server name. # # If using Redis cluster, multiple 'bootstrap' servers may be # listed here (as separate config items). These will be contacted @@ -141,12 +143,12 @@ cache { # } # - # key:: The `key` used to index the cache. It is dynamically expanded at run time. + # key:: The `key` used to index the cache. It is dynamically expanded at run time. # key = &User-Name # - # ttl:: + # ttl:: # # The TTL of cache entries, in seconds. Entries older than this # will be expired. @@ -163,7 +165,7 @@ cache { # You should never set the "epoch" configuration item in this file. # - # add_stats:: + # add_stats:: # # If `yes` the following attributes will be added to the request: # * `&request:Cache-Entry-Hits` - The number of times this entry diff --git a/raddb/mods-available/cache_eap b/raddb/mods-available/cache_eap index 5df710ac73f..70f0897d2d7 100644 --- a/raddb/mods-available/cache_eap +++ b/raddb/mods-available/cache_eap @@ -6,7 +6,7 @@ ####################################################################### # -# ## Cache EAP Module +# = Cache EAP Module # # The `cache_eap` module caches EAP replies. # diff --git a/raddb/mods-available/cache_tls b/raddb/mods-available/cache_tls index 9e0b0b828c0..cf53aa7b71f 100644 --- a/raddb/mods-available/cache_tls +++ b/raddb/mods-available/cache_tls @@ -6,9 +6,9 @@ ####################################################################### # -# ## Cache TLS Session Module +# = Cache TLS Session Module # -# The `cache_tls_session` module caches TLS sessions for resiliency. +# The `cache_tls` module caches TLS sessions for resiliency. # # This module should be listed in a `send Access-Accept` section to # write the cache, and in `recv Access-Request` to read the cache. diff --git a/raddb/mods-available/chap b/raddb/mods-available/chap index 31ce2a82623..37b39642e3a 100644 --- a/raddb/mods-available/chap +++ b/raddb/mods-available/chap @@ -6,7 +6,7 @@ ####################################################################### # -# ## CHAP module +# = CHAP module # # This module authenticates requests containing a `CHAP-Password` # attribute. diff --git a/raddb/mods-available/cipher b/raddb/mods-available/cipher index 7179589dc27..ff867c8e653 100644 --- a/raddb/mods-available/cipher +++ b/raddb/mods-available/cipher @@ -6,7 +6,7 @@ ####################################################################### # -# ## Cipher Module +# = Cipher Module # # The `cipher` module is used to transform plaintext in some way that is dependent # on a key or key pair, producing encrypted ciphertext. @@ -26,7 +26,7 @@ # You should use armouring expansions i.e. `%{base64_encode:}`, `%{base64_decode:}` if the values # are to be passed outside of FreeRADIUS. # -# E.g: +# e.g: # # %{base64_encode:%{cipher_encrypt:}} # %{cipher_decrypt:%{base64_decode:<ciphertext>}} @@ -59,11 +59,7 @@ # cipher { # - # ### RSA asymmetrically keyed ciphering - # - - # - # type:: + # type:: # # Available schemes are: # @@ -71,6 +67,9 @@ cipher { # type = rsa + # + # ### RSA asymmetrically keyed ciphering + # rsa { # private_key_password:: # diff --git a/raddb/mods-available/client b/raddb/mods-available/client index 9c30b1ecf13..423a8169ee7 100644 --- a/raddb/mods-available/client +++ b/raddb/mods-available/client @@ -6,7 +6,7 @@ ####################################################################### # -# ## Client Module +# = Client Module # # The `client` module loads RADIUS clients as needed, rather than when the server # starts. @@ -45,16 +45,16 @@ # In addition to loading `client` definitions in from flat files, the clients module can # also be used to access data from previously defined clients. # -# #### Client config item to attribute mapping. +# ### Client config item to attribute mapping. # # Maps arbitrary fields from a client definition to attributes in the current request. # # [source,unlang] # --- -# map client [<ipaddr>] { // <1> -# &Tmp-String-0 = 'nas_type' // <2> -# &Tmp-String-1 := 'shortname' // <3> -# &Tmp-String-3 += 'groups' // <4> +# map client [<ipaddr>] { // <1> +# &Tmp-String-0 = 'nas_type' // <2> +# &Tmp-String-1 := 'shortname' // <3> +# &Tmp-String-3 += 'groups' // <4> # } # --- # @@ -63,21 +63,22 @@ # <2> Assigns the value of the `nas_type` field from the client definition to # `&Tmp-String-0` if `&Tmp-String-0` doesn't exist. # <3> Assigns the value of the `shortname` field from the client definition to -# `&Tmp-String-1` +# `&Tmp-String-1`. # <4> Creates multiple `&Tmp-String-3` attributes from a custom group field associated # with the client. # -# #### Client config item access expansion. +# ### Client config item access expansion. # # [options="header,autowidth"] # |=== # | XLAT | Description -# | `%{client:nas_type}` | Expands to client's `nas_type` (or "" if nas_type not set) +# | `%{client:nas_type}` | Expands to client's `nas_type` (or "" if nas_type not set). # | `%{client:<ipaddr>.nas_type}` | Expands to the `nas_type` of the client specified # by `<ipaddr>` (or "" if `nas_type` not set). # |=== # +# # ## Default instance # # This module takes no configuration. diff --git a/raddb/mods-available/couchbase b/raddb/mods-available/couchbase index 3a4cd69c07c..d507dd561f5 100644 --- a/raddb/mods-available/couchbase +++ b/raddb/mods-available/couchbase @@ -3,9 +3,10 @@ # :toc: # # $Id$ + ####################################################################### # -# ## Couchbase Module +# = Couchbase Module # # The `couchbase` module is used to provides connections to a Couchbase database. # diff --git a/raddb/mods-available/csv b/raddb/mods-available/csv index c220c37f20b..8de5ad96435 100644 --- a/raddb/mods-available/csv +++ b/raddb/mods-available/csv @@ -6,7 +6,7 @@ ####################################################################### # -# ## CSV Module +# = CSV Module # # Read CSV files and use them in maps. # diff --git a/raddb/mods-available/cui b/raddb/mods-available/cui index 85431e7fcdb..4259ca1bdbd 100644 --- a/raddb/mods-available/cui +++ b/raddb/mods-available/cui @@ -6,7 +6,7 @@ ####################################################################### # -# ## CUI Module +# = CUI Module # # The module `cui` (`Chargeable-User-Identity`) writes # `Chargeable-User-Identity` log to an SQL database. It uses the `sql` diff --git a/raddb/mods-available/date b/raddb/mods-available/date index b96732397f8..19ed9c24f9f 100644 --- a/raddb/mods-available/date +++ b/raddb/mods-available/date @@ -3,9 +3,10 @@ # :toc: # # $Id$ + ####################################################################### # -# ## Date Module +# = Date Module # # The `date` module xlat does convert time formats. # @@ -42,11 +43,11 @@ date { # # ."Get time" mode: # - # If the input is the string "request", the `xlat` will format the + # If the input is the string `request`, the `xlat` will format the # time the current request packet arrived according to the format # string, and return it as a string. # - # If the input is the string "now", the `xlat` will behave as + # If the input is the string `now`, the `xlat` will behave as # above, for the current time. # # See also the core provided expansions which are equivalent to @@ -77,7 +78,7 @@ date { # # ### ISO format # -# The core xlat, `%T` returns the request timestamp in `ISO` format +# The core `xlat`, `%T` returns the request timestamp in `ISO` format # including milliseconds. This expansion returns it without the # millisecond component. # diff --git a/raddb/mods-available/delay b/raddb/mods-available/delay index ddea23cacc7..42b0b876b54 100644 --- a/raddb/mods-available/delay +++ b/raddb/mods-available/delay @@ -6,7 +6,7 @@ ####################################################################### # -# ## Delay Module +# = Delay Module # # The `delay` module delays the processing of a request in a # non-blocking fashion. diff --git a/raddb/mods-available/detail b/raddb/mods-available/detail index 88cce92b3e7..55aaa71d807 100644 --- a/raddb/mods-available/detail +++ b/raddb/mods-available/detail @@ -6,7 +6,7 @@ ####################################################################### # -# ## Detail Module +# = Detail Module # # Write a detailed log of all accounting records received. # diff --git a/raddb/mods-available/detail.example.com b/raddb/mods-available/detail.example.com index 456d8bcbb3c..5f30e6aee85 100644 --- a/raddb/mods-available/detail.example.com +++ b/raddb/mods-available/detail.example.com @@ -6,7 +6,7 @@ ####################################################################### # -# ## Detail Module (Sample) +# = Detail Module (Sample) # # Please see the `detail` module for full documentation. # diff --git a/raddb/mods-available/detail.log b/raddb/mods-available/detail.log index 72585c88971..145cd3a0c1a 100644 --- a/raddb/mods-available/detail.log +++ b/raddb/mods-available/detail.log @@ -6,7 +6,7 @@ ####################################################################### # -# ## Detail Module (Log Sample) +# = Detail Module (Log Sample) # # More examples of doing detail logs. # diff --git a/raddb/mods-available/dhcp_sqlippool b/raddb/mods-available/dhcp_sqlippool index 708a09c497f..b83d19fdee4 100644 --- a/raddb/mods-available/dhcp_sqlippool +++ b/raddb/mods-available/dhcp_sqlippool @@ -6,7 +6,7 @@ ####################################################################### # -# ## DHCP SQL-IP-Pool Module +# = DHCP SQL-IP-Pool Module # # The module `dhcp_sqlippool` provides configuration for `DHCP` to use `SQL IP Pools`. # @@ -17,7 +17,7 @@ # * See `raddb/sites-available/dhcp` for instructions on how to configure the DHCP server. # ==== # -# ## Default instance +# # Default instance # sqlippool dhcp_sqlippool { # diff --git a/raddb/mods-available/dhcpv4 b/raddb/mods-available/dhcpv4 index 2fe1d7b1071..1c59f45b463 100644 --- a/raddb/mods-available/dhcpv4 +++ b/raddb/mods-available/dhcpv4 @@ -6,7 +6,7 @@ ####################################################################### # -# ## DHCPv4 Module +# = DHCPv4 Module # # The `dhcpv4` module is useful only for `xlat`. To use it, # put `dhcp` into the `instantiate { ... }` section. @@ -28,7 +28,7 @@ # # -# ## Default instance +# # Default instance # # This module takes no configuration. # diff --git a/raddb/mods-available/digest b/raddb/mods-available/digest index 7e2e55ccc43..205c2323fd7 100644 --- a/raddb/mods-available/digest +++ b/raddb/mods-available/digest @@ -4,7 +4,7 @@ ####################################################################### # -# ## Digest Module +# = Digest Module # # The `digest` module is used for performing authentication against a Cisco SIP server. # diff --git a/raddb/mods-available/echo b/raddb/mods-available/echo index 0a23e24560a..b80576f5d7f 100644 --- a/raddb/mods-available/echo +++ b/raddb/mods-available/echo @@ -6,7 +6,7 @@ ####################################################################### # -# ## Echo Module +# = Echo Module # # The `echo` module is used for execute an external program in more than # one section (e.g. `recv`, `pre_proxy`, etc), then it is probably best diff --git a/raddb/mods-available/escape b/raddb/mods-available/escape index aaf5f4d810c..4da8ef65051 100644 --- a/raddb/mods-available/escape +++ b/raddb/mods-available/escape @@ -6,7 +6,7 @@ ####################################################################### # -# ## Escape Module +# = Escape Module # # The `escape` module registers two `xlat` functions. # @@ -23,7 +23,9 @@ # escape { # - # safe_characters:: List with allowed characters. + # safe_characters:: + # + # Characters that will not be encoded by the `%{escape}` `xlat` function. # safe_characters = "@abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_: /äéöüàâæçèéêëîïôœùûüaÿÄÉÖÜßÀÂÆÇÈÉÊËÎÏÔŒÙÛÜŸ" } diff --git a/raddb/mods-available/etc_group b/raddb/mods-available/etc_group index 19d38d698ef..80f851e9463 100644 --- a/raddb/mods-available/etc_group +++ b/raddb/mods-available/etc_group @@ -6,7 +6,7 @@ ####################################################################### # -# ## etc_group Module +# = etc_group Module # # The `etc_group` module provides group names from the `/etc/group` file. # diff --git a/raddb/mods-available/exec b/raddb/mods-available/exec index 638e2b040f4..a140e3ac839 100644 --- a/raddb/mods-available/exec +++ b/raddb/mods-available/exec @@ -6,7 +6,7 @@ ####################################################################### # -# ## Exec Module +# = Exec Module # # The module `exec` is used for executing external programs. # diff --git a/raddb/mods-available/expiration b/raddb/mods-available/expiration index e2b4644ba7a..a8cb707124e 100644 --- a/raddb/mods-available/expiration +++ b/raddb/mods-available/expiration @@ -6,7 +6,7 @@ ####################################################################### # -# ## Expiration Module +# = Expiration Module # # The `expiration` module manages the `Expiration` attribute. # @@ -16,7 +16,7 @@ # # -# ## Sample configuration +# ## Default instance # # This module takes no configuration. #