blob: 649b6e3e8f477138176b3dd765591b8a124042a8 [file] [log] [blame]
Henrik Nordstromc2794132004-01-22 15:04:24 +00001This target provides userspace logging of matching packets. When this
2target is set for a rule, the Linux kernel will multicast this packet
3through a
4.IR netlink
5socket. One or more userspace processes may then subscribe to various
6multicast groups and receive the packets.
7Like LOG, this is a "non-terminating target", i.e. rule traversal
8continues at the next rule.
9.TP
Jan Engelhardtfea74bf2009-01-12 04:53:18 +010010\fB\-\-ulog\-nlgroup\fP \fInlgroup\fP
Henrik Nordstromc2794132004-01-22 15:04:24 +000011This specifies the netlink group (1-32) to which the packet is sent.
12Default value is 1.
13.TP
Jan Engelhardtfea74bf2009-01-12 04:53:18 +010014\fB\-\-ulog\-prefix\fP \fIprefix\fP
Henrik Nordstromc2794132004-01-22 15:04:24 +000015Prefix log messages with the specified prefix; up to 32 characters
16long, and useful for distinguishing messages in the logs.
17.TP
Jan Engelhardtfea74bf2009-01-12 04:53:18 +010018\fB\-\-ulog\-cprange\fP \fIsize\fP
Henrik Nordstromc2794132004-01-22 15:04:24 +000019Number of bytes to be copied to userspace. A value of 0 always copies
20the entire packet, regardless of its size. Default is 0.
21.TP
Jan Engelhardtfea74bf2009-01-12 04:53:18 +010022\fB\-\-ulog\-qthreshold\fP \fIsize\fP
Henrik Nordstromc2794132004-01-22 15:04:24 +000023Number of packet to queue inside kernel. Setting this value to, e.g. 10
24accumulates ten packets inside the kernel and transmits them as one
25netlink multipart message to userspace. Default is 1 (for backwards
26compatibility).
27.br