summaryrefslogtreecommitdiffstats
path: root/extensions/libxt_IDLETIMER.man
diff options
context:
space:
mode:
authorPatrick McHardy <kaber@trash.net>2010-08-03 17:21:18 +0200
committerPatrick McHardy <kaber@trash.net>2010-08-03 17:21:18 +0200
commita653f2936c56bfc541f13a7888484d5ae21c057a (patch)
tree6cd810640b26d9c3c330c4538424edbcc5570285 /extensions/libxt_IDLETIMER.man
parentd8b511ed36f00280dd141e59c08874c7fb116504 (diff)
parent422342e47c18e70757231f2210b13df8e1f5931c (diff)
Merge branch 'iptables-next'
Diffstat (limited to 'extensions/libxt_IDLETIMER.man')
-rw-r--r--extensions/libxt_IDLETIMER.man20
1 files changed, 20 insertions, 0 deletions
diff --git a/extensions/libxt_IDLETIMER.man b/extensions/libxt_IDLETIMER.man
new file mode 100644
index 00000000..e3c91cea
--- /dev/null
+++ b/extensions/libxt_IDLETIMER.man
@@ -0,0 +1,20 @@
+This target can be used to identify when interfaces have been idle for a
+certain period of time. Timers are identified by labels and are created when
+a rule is set with a new label. The rules also take a timeout value (in
+seconds) as an option. If more than one rule uses the same timer label, the
+timer will be restarted whenever any of the rules get a hit. One entry for
+each timer is created in sysfs. This attribute contains the timer remaining
+for the timer to expire. The attributes are located under the xt_idletimer
+class:
+.PP
+/sys/class/xt_idletimer/timers/<label>
+.PP
+When the timer expires, the target module sends a sysfs notification to the
+userspace, which can then decide what to do (eg. disconnect to save power).
+.TP
+\fB\-\-timeout\fP \fIamount\fP
+This is the time in seconds that will trigger the notification.
+.TP
+\fB\-\-label\fP \fIstring\fP
+This is a unique identifier for the timer. The maximum length for the
+label string is 27 characters.