changing trunk/trunk to trunk
[iptables.git] / extensions / libxt_NFLOG.man
1 This target provides logging of matching packets. When this target is
2 set for a rule, the Linux kernel will pass the packet to the loaded
3 logging backend to log the packet. This is usually used in combination
4 with nfnetlink_log as logging backend, which will multicast the packet
5 through a
6 .IR netlink
7 socket to the specified multicast group. One or more userspace processes
8 may subscribe to the group to receive the packets. Like LOG, this is a
9 non-terminating target, i.e. rule traversal continues at the next rule.
10 .TP
11 .BI "--nflog-group " "nlgroup"
12 The netlink group (1 - 2^32-1) to which packets are (only applicable for
13 nfnetlink_log). The default value is 0.
14 .TP
15 .BI "--nflog-prefix " "prefix"
16 A prefix string to include in the log message, up to 64 characters
17 long, useful for distinguishing messages in the logs.
18 .TP
19 .BI "--nflog-range " "size"
20 The number of bytes to be copied to userspace (only applicable for
21 nfnetlink_log). nfnetlink_log instances may specify their own
22 range, this option overrides it.
23 .TP
24 .BI "--nflog-threshold " "size"
25 Number of packets to queue inside the kernel before sending them
26 to userspace (only applicable for nfnetlink_log). Higher values
27 result in less overhead per packet, but increase delay until the
28 packets reach userspace. The default value is 1.
29 .BR