Docs: indexing

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index 15b03eabbe43909ca04e7feb8dc99b6164ce7b05..ab76e873bdb3566e47942d61c1cf5b600a0f4974 100644 (file)
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -161,6 +161,13 @@
 .macro index
 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
 .endmacro
+
+
+. use this for a concept-index entry for a header line
+.macro chindex
+.cindex "&'$1'& header line"
+.cindex "header lines" $1
+.endmacro
 . ////////////////////////////////////////////////////////////////////////////
 
 
@@ -193,6 +200,8 @@
 . This chunk of literal XML implements index entries of the form "x, see y" and
 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
 . at the top level, so we have to put the .chapter directive first.
+
+. These do not turn up in the HTML output, unfortunately.  The PDF does get them.
 . /////////////////////////////////////////////////////////////////////////////
 
 .chapter "Introduction" "CHID1"
@@ -318,6 +327,10 @@
   <primary>zero, binary</primary>
   <see><emphasis>binary zero</emphasis></see>
 </indexterm>
+<indexterm role="concept">
+  <primary>headers</primary>
+  <see><emphasis>header lines</emphasis></see>
+</indexterm>
 
 .literal off
 
@@ -2683,10 +2696,8 @@ Exim through the local interface (see the &%-bm%& and &%-f%& options below).
 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
 users to set envelope senders.
 
-.cindex "&'From:'& header line"
-.cindex "&'Sender:'& header line"
-.cindex "header lines" "From:"
-.cindex "header lines" "Sender:"
+.chindex From:
+.chindex Sender:
 For a trusted user, there is never any check on the contents of the &'From:'&
 header line, and a &'Sender:'& line is never added. Furthermore, any existing
 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
@@ -4784,9 +4795,9 @@ recognized when Exim is run normally. It allows for the setting up of explicit
 .vitem &%-t%&
 .oindex "&%-t%&"
 .cindex "recipient" "extracting from header lines"
-.cindex "&'Bcc:'& header line"
-.cindex "&'Cc:'& header line"
-.cindex "&'To:'& header line"
+.chindex Bcc:
+.chindex Cc:
+.chindex To:
 When Exim is receiving a locally-generated, non-SMTP message on its standard
 input, the &%-t%& option causes the recipients of the message to be obtained
 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
@@ -9718,7 +9729,7 @@ If the ACL returns defer the result is a forced-fail.  Otherwise the expansion f
 
 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
 .cindex authentication "results header"
-.cindex headers "authentication-results:"
+.chindex Authentication-Results:
 .cindex authentication "expansion item"
 This item returns a string suitable for insertion as an
 &'Authentication-Results:'&
@@ -22583,7 +22594,7 @@ This defaults to the incoming sender address, but can be changed by setting
 
 
 .option return_path_add transports boolean false
-.cindex "&'Return-path:'& header line"
+.chindex Return-path:
 If this option is true, a &'Return-path:'& header is added to the message.
 Although the return path is normally available in the prefix line of BSD
 mailboxes, this is commonly not displayed by MUAs, and so the user does not
@@ -36030,8 +36041,7 @@ incoming SMTP message from a source that is not permitted to send them.
 
 
 .section "Resent- header lines" "SECID220"
-.cindex "&%Resent-%& header lines"
-.cindex "header lines" "Resent-"
+.chindex Resent-
 RFC 2822 makes provision for sets of header lines starting with the string
 &`Resent-`& to be added to a message when it is resent by the original
 recipient to somebody else. These headers are &'Resent-Date:'&,
@@ -36087,8 +36097,7 @@ existing &'Bcc:'& is not removed.
 
 
 .section "The Date: header line" "SECID223"
-.cindex "&'Date:'& header line"
-.cindex "header lines" "Date:"
+.cindex Date:
 If a locally-generated or submission-mode message has no &'Date:'& header line,
 Exim adds one, using the current date and time, unless the
 &%suppress_local_fixups%& control has been specified.
@@ -36105,8 +36114,7 @@ messages.
 
 
 .section "The Envelope-to: header line" "SECID225"
-.cindex "&'Envelope-to:'& header line"
-.cindex "header lines" "Envelope-to:"
+.chindex Envelope-to:
 .oindex "&%envelope_to_remove%&"
 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
 Exim can be configured to add them to the final delivery of messages. (See the
@@ -36117,8 +36125,7 @@ messages.
 
 
 .section "The From: header line" "SECTthefrohea"
-.cindex "&'From:'& header line"
-.cindex "header lines" "From:"
+.chindex From:
 .cindex "Sendmail compatibility" "&""From""& line"
 .cindex "message" "submission"
 .cindex "submission mode"
@@ -36161,8 +36168,7 @@ name as described in section &<<SECTconstr>>&.
 
 
 .section "The Message-ID: header line" "SECID226"
-.cindex "&'Message-ID:'& header line"
-.cindex "header lines" "Message-ID:"
+.chindex Message-ID:
 .cindex "message" "submission"
 .oindex "&%message_id_header_text%&"
 If a locally-generated or submission-mode incoming message does not contain a
@@ -36177,8 +36183,7 @@ in this header line by setting the &%message_id_header_text%& and/or
 
 
 .section "The Received: header line" "SECID227"
-.cindex "&'Received:'& header line"
-.cindex "header lines" "Received:"
+.chindex Received:
 A &'Received:'& header line is added at the start of every message. The
 contents are defined by the &%received_header_text%& configuration option, and
 Exim automatically adds a semicolon and a timestamp to the configured string.
@@ -36194,8 +36199,7 @@ changed to the time of acceptance, which is (apart from a small delay while the
 
 
 .section "The References: header line" "SECID228"
-.cindex "&'References:'& header line"
-.cindex "header lines" "References:"
+.chindex References:
 Messages created by the &(autoreply)& transport include a &'References:'&
 header line. This is constructed according to the rules that are described in
 section 3.64 of RFC 2822 (which states that replies should contain such a
@@ -36209,8 +36213,7 @@ incoming message. If there are more than 12, the first one and then the final
 
 
 .section "The Return-path: header line" "SECID229"
-.cindex "&'Return-path:'& header line"
-.cindex "header lines" "Return-path:"
+.chindex Return-path:
 .oindex "&%return_path_remove%&"
 &'Return-path:'& header lines are defined as something an MTA may insert when
 it does the final delivery of messages. (See the generic &%return_path_add%&
@@ -36223,7 +36226,7 @@ default), Exim removes &'Return-path:'& header lines from incoming messages.
 .section "The Sender: header line" "SECTthesenhea"
 .cindex "&'Sender:'& header line"
 .cindex "message" "submission"
-.cindex "header lines" "Sender:"
+.chindex Sender:
 For a locally-originated message from an untrusted user, Exim may remove an
 existing &'Sender:'& header line, and it may add a new one. You can modify
 these actions by setting the &%local_sender_retain%& option true, the