diff --git a/ChangeLog.txt b/ChangeLog.txt index 545cd73..a06f19c 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -6,6 +6,12 @@ # file, you can obtain one at https://mozilla.org/MPL/2.0/. # +Version 1.2.1 - 2022-03-23 +-------------------------- + +* Minor documentation update to address + https://github.com/dns-stats/compactor/issues/80 + Version 1.2.1-rc2 - 2022-01-26 -------------------------- diff --git a/doc/user-guide/compactor-outputs.adoc.in b/doc/user-guide/compactor-outputs.adoc.in index f3f40c0..346e800 100644 --- a/doc/user-guide/compactor-outputs.adoc.in +++ b/doc/user-guide/compactor-outputs.adoc.in @@ -81,26 +81,28 @@ the `excludesfile` option. See the user guide for more information. *-G, --ignore-opcode* _OPCODE_:: - Indicate an opcode _OPCODE_ that should not be included in the main output. - This argument can be given multiple times. + DNS messages with this _OPCODE_ should NOT be included in the main output + (the DNS message is discarded). This argument can be given multiple times. *-E, --accept-opcode* _OPCODE_:: - Indicate an opcode _OPCODE_ that should be included in the main output. + DNS messages with this _OPCODE_ should be included in the main output (if + used, messages with OPCODES not specified with this option are discarded). This argument can be given multiple times. *-g, --ignore-rr-type* _TYPE_:: - Indicate an RR type _TYPE_ that should not be included in the main output. - The first question is always included, but _TYPE_ nominated using the RR type - name (in upper case) will be omitted from any other question and from - any Answer, Authority or Additional section. This argument can be given - multiple times. + Records of this RR type _TYPE_ should NOT be included in DNS messages when + they are written to the main output. Note that the first question is ALWAYS + included, but _TYPE_ nominated using the RR type name (in upper case) will + be omitted from any other question and from any Answer, Authority or + Additional section. This argument can be given multiple times. *-e, --accept-rr-type* _TYPE_:: - Indicate an RR type _TYPE_ that should be included in the main output. - The first question is always included, but only _TYPE_ nominated using - the RR type name (in upper case) will be included in any other question - and in any Answer, Authority or Additional section. This argument can be - given multiple times. + Records of this RR type _TYPE_ should be included in DNS messages when they + are written to the main output (if used, RR types not specified with this + option will be omitted from DNS messages). Note that the first question is + ALWAYS included, but only _TYPE_ nominated using the RR type name (in upper + case) will be included in any other question and in any Answer, Authority or + Additional section. This argument can be given multiple times. *--max-block-items* _arg_:: Set the maximum number of query/response items or address event items diff --git a/etc/compactor.conf.in b/etc/compactor.conf.in index a58c3f9..260dfc0 100644 --- a/etc/compactor.conf.in +++ b/etc/compactor.conf.in @@ -47,10 +47,12 @@ # the address must be present on a capture interface. # server-address-hint= -# RR type to ignore. Type name in UPPER CASE e.g. AAAA, RRSIG. +# Omit records of this RR type from the content of DNS messages when writing output +# (note - the first question is always written). Type name in UPPER CASE e.g. AAAA, RRSIG. # ignore-rr-type= -# RR type to accept. Type name in UPPER CASE e.g. AAAA, RRSIG. +# Include records of this RR type in the content of DNS messages when writing output +# (note - the first question is always written). Type name in UPPER CASE e.g. AAAA, RRSIG. # accept-rr-type= # Log basic collection stats to syslog every n seconds. 0 (default) == never.