Add ToC
authorArran Cudbard-Bell <a.cudbardb@freeradius.org>
Thu, 20 Mar 2014 18:15:35 +0000 (18:15 +0000)
committerArran Cudbard-Bell <a.cudbardb@freeradius.org>
Thu, 20 Mar 2014 18:17:53 +0000 (18:17 +0000)
README.rst

index 4b79347..53b72a3 100644 (file)
@@ -3,8 +3,11 @@ The FreeRADIUS server
 
 |BuildStatus|_ |CoverityStatus|_
 
-1. INTRODUCTION
----------------
+.. contents::
+   :local:
+
+Introduction
+------------
 
 The FreeRADIUS Server Project is a high performance and highly
 configurable RADIUS server that is available under the terms of the
@@ -38,14 +41,14 @@ Please see http://freeradius.org and http://wiki.freeradius.org for
 more information.
 
 
-2. INSTALLATION
----------------
+Installation
+------------
 
 To install the server, please see the INSTALL file in this directory.
 
 
-3. DEBUGGING THE SERVER
------------------------
+Debugging the Server
+--------------------
 
 Run the server in debugging mode, (``radiusd -X``) and READ the output.
 We cannot emphasize this point strongly enough.  The vast majority of
@@ -69,8 +72,8 @@ Type some key words into the search box, and you should find
 discussions about common problems and solution.
 
 
-4. ADDITIONAL INFORMATION
--------------------------
+Additional Information
+----------------------
 
 See ``doc/README`` for more information about FreeRADIUS.
 
@@ -92,8 +95,8 @@ Especially worth reading is the "RADIUS for Unix administrators guide"
 * PDF:   http://portmasters.com/tech/docs/pdf/radius.pdf
 
 
-5. PROBLEMS AND CONCERNS
-------------------------
+Problems and Concerns
+---------------------
 
 We understand that the server may be difficult to configure,
 install, or administer.  It is, after all, a complex system with many
@@ -108,10 +111,10 @@ following:
 2. Save a copy of the default configuration: It WORKS.  Don't change it!
 3. Verify that the server starts.  (You ARE using debugging mode, right?)
 4. Send it test packets using "radclient", or a NAS or AP.
-5. Verify that the server does what you expect.
-      - If it does not work, change the configuration, and go to step (3) 
-        If you're stuck, revert to using the "last working" configuration.
-      - If it works, proceed to step (6).
+5. Verify that the server does what you expect
+    - If it does not work, change the configuration, and go to step (3) 
+    - If you're stuck, revert to using the "last working" configuration.
+    - If it works, proceed to step (6).
 6. Save a copy of the working configuration, along with a note of what 
    you changed, and why.
 7. Make a SMALL change to the configuration.
@@ -124,8 +127,8 @@ will always take more time.  The "fast and loose" way will be MORE
 frustrating than quickly making forward progress!
 
 
-6. FEEDBACK
------------
+Feedback
+--------
 
 If you have any comments, bug reports, problems, or concerns, please
 send them to the 'freeradius-users' list (see the URL above).  We will