move text to top-level README

diff --git a/share/dictionary/README.md b/share/dictionary/README.md
index 19e3116d28275be4448bc992f4fb7d23f85c2302..251534c69c24c5e987237bb57061b59c59fe0d8f 100644 (file)
--- a/share/dictionary/README.md
+++ b/share/dictionary/README.md
@@ -1,6 +1,36 @@
-# Protocol Registry
+# Dictionary files for FreeRADIUS
 
-    git grep -h '^PROTOCOL' | sort -nk 3
+WARNING: **DO NOT EDIT THE FILES IN THIS DIRECTORY**
+
+The files in this directory are maintained by the FreeRADIUS project.
+Newer releases of software may update or change these files. Any edits
+you make to these files will be over-written when an updated version
+of the software is installed.
+
+Please use the site-local dictionary file (usually `/etc/raddb/dictionary`)
+for local attributes.  See that file for more documentation on how it works.
+
+The files in this directory contains dictionary translations for
+"binary" protocol data to/from "humanly readable" names.
+
+## File Format
+
+Please see the official documentation for full details of the
+dictionary file format.
+
+While these files are _mostly_ compatible with the original dictionary
+files used since 1993, we have made some changes, and added new
+features.  Those differences cannot be documented in a short "readme"
+file.
+
+## Protocol Registry
+
+The following is a list of protocols currently supported in the
+dictionaries.  It is here for informational purposes only.
+
+```
+git grep -h '^PROTOCOL' | sort -nk 3
+```
 
 ## Current Protocols
 

diff --git a/share/dictionary/radius/dictionary b/share/dictionary/radius/dictionary
index cd703b768ed55f351c4dfd4686329f4bc25ae333..cd7e835cc22079b1a361eac0ec0249456c442863 100644 (file)
--- a/share/dictionary/radius/dictionary
+++ b/share/dictionary/radius/dictionary
@@ -3,61 +3,6 @@
 # This work is licensed under CC-BY version 4.0 https://creativecommons.org/licenses/by/4.0
 # Version $Id$
 #
-#
-#      DO NOT EDIT THE FILES IN THIS DIRECTORY
-#
-#      The files in this directory are maintained and updated by
-#      the FreeRADIUS project.  Newer releases of software may update
-#      or change these files.
-#
-#      Use the main dictionary file (usually /etc/raddb/dictionary)
-#      for local system attributes and $INCLUDEs.
-#
-#
-#
-#      This file contains dictionary translations for parsing
-#      requests and generating responses.  All transactions are
-#      composed of Attribute/Value Pairs.  The value of each attribute
-#      is specified as one of a few data types.  Valid data types are:
-#
-#      string     - printable text, generally UTF-8 encoded.  (The RFCs call this "text")
-#      ipaddr     - 4 octets in network byte order
-#      ipv4prefix - 1 octet reserved, one octet prefix, 4 octets ipaddr
-#      integer    - 32 bit value in big endian order
-#      integer64  - 64 bit value in big endian order
-#      date       - 32 bit value in big endian order - seconds since
-#                   00:00:00 GMT,  Jan.  1,  1970
-#      ifid       - 8 octets in network byte order
-#      ipv6addr   - 16 octets in network byte order
-#      ipv6prefix - 1 octet reserved, one octet prefix, 16 octets ipv6addr
-#      tlv        - type-length-value
-#
-#      FreeRADIUS includes data types which are not defined
-#      in the RFC's.  These data types are:
-#
-#      byte    - 8 bit unsigned integer
-#      ether   - 6 octets of hh:hh:hh:hh:hh:hh
-#                where 'h' is hex digits, upper or lowercase.
-#      short   - 16-bit unsigned integer in network byte order
-#      signed  - 32-bit signed integer in network byte order
-#      octets  - raw octets, printed and input as hex strings.
-#                e.g.: 0x123456789abcdef  The RFCs call this "string".
-#
-#      FreeRADIUS uses a number of data types which are defined in
-#      RFC 6929.  These data types should NEVER be used in any other
-#      dictionary.  We won't even list them here.
-#
-#
-#      Enumerated values are stored in the user file with dictionary
-#      VALUE translations for easy administration.
-#
-#      Example:
-#
-#      ATTRIBUTE         VALUE
-#      ---------------   -----
-#      Framed-Protocol = PPP
-#      7               = 1     (integer encoding)
-#
 
 PROTOCOL       RADIUS          1       verify=lib
 BEGIN-PROTOCOL RADIUS