INN commit: trunk (3 files)

[INN Commit]

    Date: Friday, September 4, 2015 @ 05:58:15
  Author: iulius
Revision: 9940

Improve documentation for RADIUS

Better POD syntax, typo fix, and remove the comment in the
inn-radius.conf sample file about the impossibility to use a hash
tag (#) in the secret password.

Modified:
  trunk/doc/pod/inn-radius.conf.pod
  trunk/doc/pod/radius.pod
  trunk/samples/inn-radius.conf

-----------------------------+
 doc/pod/inn-radius.conf.pod |   12 +++++++-----
 doc/pod/radius.pod          |   29 ++++++++++++++---------------
 samples/inn-radius.conf     |   20 ++++++++++----------
 3 files changed, 31 insertions(+), 30 deletions(-)

Modified: doc/pod/inn-radius.conf.pod
===================================================================
--- doc/pod/inn-radius.conf.pod	2015-09-03 08:22:27 UTC (rev 9939)
+++ doc/pod/inn-radius.conf.pod	2015-09-04 12:58:15 UTC (rev 9940)
@@ -4,10 +4,10 @@
 
 =head1 DESCRIPTION
 
-This describes the format and attributes of the configuration file for the
-nnrpd RADIUS authenticator.  See radius(8) for more information about the
-authenticator program.  The default location for this file is
-F<inn-radius.conf> in I<pathetc>.
+This describes the format and attributes of the configuration file for
+the B<nnrpd> RADIUS authenticator.  See radius(8) for more information
+about the authenticator program.  The default location for this file
+is F<inn-radius.conf> in I<pathetc>.
 
 Blank lines and lines beginning with C<#> are ignored, as is anything
 after a C<#> on a line.  All other lines should begin with a parameter
@@ -20,6 +20,8 @@
 
 where <name> is just some convenient label for that server.
 
+=head1 SERVER GROUP PARAMETERS
+
 The available parameters are:
 
 =over 4
@@ -104,6 +106,6 @@
 
 =head1 SEE ALSO
 
-radius(8)
+radius(8).
 
 =cut

Modified: doc/pod/radius.pod
===================================================================
--- doc/pod/radius.pod	2015-09-03 08:22:27 UTC (rev 9939)
+++ doc/pod/radius.pod	2015-09-04 12:58:15 UTC (rev 9940)
@@ -8,17 +8,18 @@
 
 =head1 DESCRIPTION
 
-B<radius> is an nnrpd authenticator, accepting a username and password
-from nnrpd (given to nnrpd by a reader connection) and attempting to
-authenticate that username and password against a RADIUS server.  See
-readers.conf(5) for more information on how to configure an nnrpd
-authenticator.  It is useful for a site that already does user
-authentication via RADIUS and wants to authenticate news reading
+B<radius> is an B<nnrpd> authenticator, accepting a username and
+password from B<nnrpd> (given to B<nnrpd> by a reader connection) and
+attempting to authenticate that username and password against a RADIUS
+server.  See readers.conf(5) for more information on how to configure
+an B<nnrpd> authenticator.  It is useful for a site that already does
+user authentication via RADIUS and wants to authenticate news reading
 connections as well.
 
 By default, B<radius> reads I<pathetc>/inn-radius.conf for configuration
 information, but a different configuration file can be specified with
-B<-f>.  See inn-radius.conf(5) for a description of the configuration file.
+B<-f>.  See inn-radius.conf(5) for a description of the configuration
+file.
 
 =head1 OPTIONS
 
@@ -37,8 +38,8 @@
 
 =head1 EXAMPLE
 
-The following readers.conf(5) fragment tells nnrpd to authenticate all
-connections using this authenticator:
+The following readers.conf(5) fragment tells B<nnrpd> to authenticate
+all connections using this authenticator:
 
     auth radius {
         auth: radius
@@ -46,9 +47,9 @@
         default-domain: example.com
     }
 
-C<@example.com> will be appended to the user-supplied identity, and if
-RADIUS authentication failes, the user will be assigned an identity of
-C<E<lt>FAILE<gt>@example.com>.
+C<@example.com> will be appended to the user-supplied identity, and
+if RADIUS authentication fails, the user will be assigned an identity
+of C<E<lt>FAILE<gt>@example.com>.
 
 =head1 BUGS
 
@@ -70,8 +71,6 @@
 
 =head1 SEE ALSO
 
-inn-radius.conf(5), nnrpd(8), readers.conf(5)
+inn-radius.conf(5), nnrpd(8), readers.conf(5).
 
-S<RFC 2865>, Remote Authentication Dial In User Service.
-
 =cut

Modified: samples/inn-radius.conf
===================================================================
--- samples/inn-radius.conf	2015-09-03 08:22:27 UTC (rev 9939)
+++ samples/inn-radius.conf	2015-09-04 12:58:15 UTC (rev 9940)
@@ -14,32 +14,32 @@
 
 radport:        1645
 
-# Local hostname or IP address.
+# Local hostname or IP address making the request.
 #
 # The RADIUS server expects an IP address; a hostname will be translated
-# into an IP address with gethostbyname().  If not given, not included in
-# the request (not all RADIUS setups need this information).
+# into an IP address with gethostbyname().  If not given, this information
+# is not included in the request (not all RADIUS setups need this information).
 
 #lochost:       news.example.com
 
 # Local port of connection.
 #
-# The port the client we're authenticating is connecting to.  If not
-# given, defaults to 119.  You'll only need to set this if you're readers
-# are connecting on a non-standard port.
+# The port the client being authenticated is connecting to.  If not
+# given, defaults to 119.  This doesn't need to be set unless readers are
+# connecting to a non-standard port.
 
 #locport:       119
 
-# Shared secret with RADIUS server.
+# Shared secret with the RADIUS server.
 #
-# Be careful not to use the '#' symbol in your secret, since in this
-# file that indicates the beginning of a comment.
+# If your secret includes spaces, tabs, or #, be sure to include it
+# in double quotes.
 
 #secret:        SECRET-WORD
 
 # Prefix for username.
 #
-# Before given to the RADIUS server, usernames will be rewritten by
+# Before being given to the RADIUS server, usernames will be rewritten by
 # prepending the prefix, if given, and then appending the suffix, if
 # given.