Update with documentation on the object identifier configuration files.

svn path=/trunk/; revision=33311

diff --git a/doc/wireshark.pod.template b/doc/wireshark.pod.template
index 9707311cd7ded32651afe03188f04de7c1c1625d..f7e317828887ed2b036ab425ee0165d6f69ca78b 100644 (file)
--- a/doc/wireshark.pod.template
+++ b/doc/wireshark.pod.template
@@ -2584,6 +2584,68 @@ If the global F<colorfilters> file exists, it is used only if the personal
 F<colorfilters> file does not exist; global and personal color filters are
 not merged.
 
+=item Object Identifiers
+
+The F<object identifier (OID)> files contain personal settings for the display of object 
+identifiers and the decoding of their associated values. 
+
+They allow the user to:
+
+=over 4
+
+=item * 
+
+Add names and/or syntaxes for OIDs that Wireshark doesn't natively understand
+
+=item * 
+
+Override the built-in OID names (e.g. change 'id-at-organization' to 'o')
+
+=item * 
+
+Use a special syntax, "ASN.1", that allows a value associated with an OID 
+to be dissected as "unknown ber". (This is a effectively a selective 
+version of the "Decode unexpected tags as BER encoded data" BER option.)
+
+=back
+
+The configuration file is an ini style file, with the dotted OID used as
+the section/group, and two keys defined, "name" and "syntax".
+
+The BER preferences page contains a configuration item for the OID files. A single 
+configuration file may be specified, or a directory may be specified. If a 
+directory is specified, then the files with a ".oid" extension will be loaded.
+
+An example configuration file:
+
+  # a comment
+  [2.5.21.5]
+  name=attributeTypes
+  syntax=ASN.1
+  [2.5.21.6]
+  name=objectClasses
+  [2.5.21.7]
+  name=nameForms
+  [1.2.840.10040.4.3]
+  name=id-dsa-with-sha1
+  [2.5.4.6]
+  name=c
+  [2.5.4.10]
+  name=o
+  [2.5.4.11]
+  name=ou
+  [2.5.4.3]
+  name=cn
+  [1.3.32.0.2.0.4.66]
+  name=Unknown OID
+  syntax=PrintableString
+  [0.9.2342.19200300.100.1.10]
+  name=unknown dn
+  syntax=DistinguishedName
+
+The list of known syntaxes is shown in the "Decode As ..." dialog when 
+examining a BER file.
+
 =item GTK rc files
 
 The F<gtkrc> files contain system-wide and personal GTK theme settings.