Documentation for udpsend and ${hexquote:
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
index 842dd8ffd8a40cd8debe488f8b204a43b0ec9976..bf50a9be841e19057ed926dc02012565c9482bb4 100644 (file)
@@ -9777,6 +9777,16 @@ This operator converts a hex string into one that is base64 encoded. This can
 be useful for processing the output of the MD5 and SHA-1 hashing functions.
 
 
 be useful for processing the output of the MD5 and SHA-1 hashing functions.
 
 
+
+.vitem &*${hexquote:*&<&'string'&>&*}*&
+.cindex "quoting" "hex-encoded unprintable characters"
+.cindex "&%hexquote%& expansion item"
+This operator converts non-printable characters in a string into a hex
+escape form. Byte values between 33 (!) and 126 (~) inclusive are left
+as is, and other byte values are converted to &`\xNN`&, for example a
+byt value 127 is converted to &`\x7f`&.
+
+
 .vitem &*${lc:*&<&'string'&>&*}*&
 .cindex "case forcing in strings"
 .cindex "string" "case forcing"
 .vitem &*${lc:*&<&'string'&>&*}*&
 .cindex "case forcing in strings"
 .cindex "string" "case forcing"
@@ -27074,6 +27084,21 @@ the message is ultimately accepted. For details, see section &<<SECTremoveheadac
 .cindex "&%set%& ACL modifier"
 This modifier puts a value into one of the ACL variables (see section
 &<<SECTaclvariables>>&).
 .cindex "&%set%& ACL modifier"
 This modifier puts a value into one of the ACL variables (see section
 &<<SECTaclvariables>>&).
+
+
+.vitem &*udpsend*&&~=&~<&'parameters'&>
+This modifier sends a UDP packet, for purposes such as statistics
+collection or behaviour monitoring. The parameters are expanded, and
+the result of the expansion must be a colon-separated list consisting
+of a destination server, port number, and the packet contents. The
+server can be specified as a host name or IPv4 or IPv6 address. The
+separator can be changed with the usual angle bracket syntax. For
+example, you might want to collect information on which hosts connect
+when:
+.code
+udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
+             $tod_zulu $sender_host_address
+.endd
 .endlist
 
 
 .endlist
 
 
@@ -35643,7 +35668,7 @@ has &%use_shell%& enabled.
 .next
 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
 .next
 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
-&_.forward_ files in a redirect router. If Exim is running on a central mail
+&_.forward_& files in a redirect router. If Exim is running on a central mail
 hub to which ordinary users do not have shell access, but home directories are
 NFS mounted (for instance) then administrators should review the list of these
 forbid options available, and should bear in mind that the options that may
 hub to which ordinary users do not have shell access, but home directories are
 NFS mounted (for instance) then administrators should review the list of these
 forbid options available, and should bear in mind that the options that may